write_xlsx 0.60.0 → 0.61.0

data/lib/write_xlsx/package/shared_strings.rb

@@ -14,8 +14,8 @@ module Writexlsx
         @count   = {} # => count
       end
 
-      def index(string)
-        add(string)
+      def index(string, params = {})
+        add(string) unless params[:only_query]
         @strings.index(string)
       end
 

data/lib/write_xlsx/package/vml.rb

@@ -31,7 +31,7 @@ module Writexlsx
             worksheet.buttons_data.each do |button|
               # Write the v:shape element.
               vml_shape_id += 1
-              write_button_shape(vml_shape_id, z_index, button)
+              button.write_shape(@writer, vml_shape_id, z_index)
               z_index += 1
             end
           end
@@ -41,7 +41,7 @@ module Writexlsx
             worksheet.comments_array.each do |comment|
               # Write the v:shape element.
               vml_shape_id += 1
-              write_comment_shape(vml_shape_id, z_index, comment)
+              comment.write_shape(@writer, vml_shape_id, z_index)
               z_index += 1
             end
           end
@@ -52,22 +52,6 @@ module Writexlsx
 
       private
 
-      #
-      # Convert comment vertices from pixels to points.
-      #
-      def pixels_to_points(vertices)
-        col_start, row_start, x1,    y1,
-        col_end,   row_end,   x2,    y2,
-        left,      top,       width, height  = vertices.flatten
-
-        left   *= 0.75
-        top    *= 0.75
-        width  *= 0.75
-        height *= 0.75
-
-        [left, top, width, height]
-      end
-
       #
       # Write the <xml> element. This is the root element of VML.
       #
@@ -91,9 +75,7 @@ module Writexlsx
       # Write the <o:shapelayout> element.
       #
       def write_shapelayout(data_id)
-        ext     = 'edit'
-
-        attributes = ['v:ext', ext]
+        attributes = ['v:ext', 'edit']
 
         @writer.tag_elements('o:shapelayout', attributes) do
           # Write the o:idmap element.
@@ -105,10 +87,8 @@ module Writexlsx
       # Write the <o:idmap> element.
       #
       def write_idmap(data_id)
-        ext     = 'edit'
-
         attributes = [
-          'v:ext', ext,
+          'v:ext', 'edit',
           'data',  data_id
         ]
 
@@ -139,11 +119,11 @@ module Writexlsx
       #
       def write_button_shapetype
         attributes = [
-            'id',        '_x0000_t201',
-            'coordsize', '21600,21600',
-            'o:spt',     201,
-            'path',      'm,l,21600r21600,l21600,xe'
-        ]
+                      'id',        '_x0000_t201',
+                      'coordsize', '21600,21600',
+                      'o:spt',     201,
+                      'path',      'm,l,21600r21600,l21600,xe'
+                     ]
 
         @writer.tag_elements('v:shapetype', attributes) do
           # Write the v:stroke element.
@@ -155,29 +135,6 @@ module Writexlsx
         end
       end
 
-      #
-      # Write the <v:stroke> element.
-      #
-      def write_stroke
-        joinstyle = 'miter'
-
-        attributes = ['joinstyle', joinstyle]
-
-        @writer.empty_tag('v:stroke', attributes)
-      end
-
-      #
-      # Write the <v:path> element.
-      #
-      def write_comment_path(gradientshapeok, connecttype)
-        attributes      = []
-
-        attributes << 'gradientshapeok' << 't' if gradientshapeok
-        attributes << 'o:connecttype' << connecttype
-
-        @writer.empty_tag('v:path', attributes)
-      end
-
       #
       # Write the <v:path> element.
       #
@@ -202,373 +159,6 @@ 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 <v:shape> element.
-      #
-      def write_comment_shape(id, z_index, comment)
-        type       = '#_x0000_t202'
-        insetmode  = 'auto'
-        visibility = 'hidden'
-
-        # Set the shape index.
-        id = '_x0000_s' + id.to_s
-
-        left, top, width, height = pixels_to_points(comment.vertices)
-
-        # Set the visibility.
-        visibility = 'visible' if comment.visible != 0 && !comment.visible.nil?
-
-        left_str    = float_to_str(left)
-        top_str     = float_to_str(top)
-        width_str   = float_to_str(width)
-        height_str  = float_to_str(height)
-        z_index_str = float_to_str(z_index)
-
-        style =
-            '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 + ';'    +
-            'visibility:'        +
-            visibility
-
-
-        attributes = [
-            'id',          id,
-            'type',        type,
-            'style',       style,
-            'fillcolor',   comment.color,
-            'o:insetmode', insetmode
-        ]
-
-        @writer.tag_elements('v:shape', attributes) do
-          # Write the v:fill element.
-          write_comment_fill
-          # Write the v:shadow element.
-          write_shadow
-          # Write the v:path element.
-          write_comment_path(nil, 'none')
-          # Write the v:textbox element.
-          write_comment_textbox
-          # Write the x:ClientData element.
-          write_comment_client_data(comment)
-        end
-      end
-
-      #
-      # Write the <v:shape> element.
-      #
-      def write_button_shape(id, z_index, button)
-        type = '#_x0000_t201'
-
-        # Set the shape index.
-        id = "_x0000_s#{id}"
-
-        left, top, width, height = pixels_to_points(button[:_vertices])
-
-        left_str    = float_to_str(left)
-        top_str     = float_to_str(top)
-        width_str   = float_to_str(width)
-        height_str  = float_to_str(height)
-        z_index_str = float_to_str(z_index)
-
-        style =
-            '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 + ';'    +
-            'mso-wrap-style:tight'
-
-        attributes = [
-                      'id',          id,
-                      'type',        type,
-                      'style',       style,
-                      'o:button',    't',
-                      'fillcolor',   'buttonFace [67]',
-                      'strokecolor', 'windowText [64]',
-                      'o:insetmode', 'auto'
-        ]
-
-        @writer.tag_elements('v:shape', attributes) do
-          # Write the v:fill element.
-          write_button_fill
-          # Write the o:lock element.
-          write_rotation_lock
-          # Write the v:textbox element.
-          write_button_textbox(button[:_font])
-          # Write the x:ClientData element.
-          write_button_client_data(button)
-        end
-      end
-
-      def float_to_str(float)
-        return '' unless float
-        if float == float.to_i
-          float.to_i.to_s
-        else
-          float.to_s
-        end
-      end
-
-      #
-      # Write the <v:fill> element.
-      #
-      def write_comment_fill
-        color_2 = '#ffffe1'
-        attributes = ['color2', color_2]
-
-        @writer.empty_tag('v:fill', attributes)
-      end
-
-      #
-      # Write the <v:fill> element.
-      #
-      def write_button_fill
-        color_2          = 'buttonFace [67]'
-        detectmouseclick = 't'
-
-        attributes = [
-                      'color2',             color_2,
-                      'o:detectmouseclick', detectmouseclick
-                     ]
-
-        @writer.empty_tag('v:fill', attributes)
-      end
-
-      #
-      # Write the <v:shadow> element.
-      #
-      def write_shadow
-        on       = 't'
-        color    = 'black'
-        obscured = 't'
-
-        attributes = [
-            'on',       on,
-            'color',    color,
-            'obscured', obscured
-        ]
-
-        @writer.empty_tag('v:shadow', attributes)
-      end
-
-      #
-      # Write the <v:textbox> element.
-      #
-      def write_comment_textbox
-        style = 'mso-direction-alt:auto'
-
-        attributes = ['style', style]
-
-        @writer.tag_elements('v:textbox', attributes) do
-          # Write the div element.
-          write_div('left')
-        end
-      end
-
-      #
-      # Write the <v:textbox> element.
-      #
-      def write_button_textbox(font)
-        style = 'mso-direction-alt:auto'
-
-        attributes = ['style', style, 'o:singleclick', 'f']
-
-        @writer.tag_elements('v:textbox', attributes) do
-          # Write the div element.
-          write_div('center', font)
-        end
-      end
-
-      #
-      # Write the <div> element.
-      #
-      def write_div(align, font = nil)
-        style = "text-align:#{align}"
-        attributes = ['style', style]
-
-        @writer.tag_elements('div', attributes) do
-          if font
-            # Write the font element.
-            write_font(font)
-          end
-        end
-      end
-
-      #
-      # Write the <font> element.
-      #
-      def write_font(font)
-        caption = font[:_caption]
-        face    = 'Calibri'
-        size    = 220
-        color   = '#000000'
-
-        attributes = [
-                      'face',  face,
-                      'size',  size,
-                      'color', color
-                     ]
-        @writer.data_element('font', caption, attributes)
-      end
-
-      #
-      # Write the <x:ClientData> element.
-      #
-      def write_comment_client_data(comment)
-        object_type = 'Note'
-
-        attributes = ['ObjectType', object_type]
-
-        @writer.tag_elements('x:ClientData', attributes) do
-          # Write the x:MoveWithCells element.
-          write_move_with_cells
-          # Write the x:SizeWithCells element.
-          write_size_with_cells
-          # Write the x:Anchor element.
-          write_anchor(comment.vertices)
-          # Write the x:AutoFill element.
-          write_auto_fill
-          # Write the x:Row element.
-          write_row(comment.row)
-          # Write the x:Column element.
-          write_column(comment.col)
-          # Write the x:Visible element.
-          write_visible if comment.visible != 0 && !comment.visible.nil?
-        end
-      end
-
-      #
-      # Write the <x:ClientData> element.
-      #
-      def write_button_client_data(button)
-        object_type = 'Button'
-
-        attributes = ['ObjectType', object_type]
-
-        @writer.tag_elements('x:ClientData', attributes) do
-          # Write the x:Anchor element.
-          write_anchor(button[:_vertices])
-          # Write the x:PrintObject element.
-          write_print_object
-          # Write the x:AutoFill element.
-          write_auto_fill
-          # Write the x:FmlaMacro element.
-          write_fmla_macro(button[:_macro])
-          # Write the x:TextHAlign element.
-          write_text_halign
-          # Write the x:TextVAlign element.
-          write_text_valign
-        end
-      end
-
-      #
-      # Write the <x:MoveWithCells> element.
-      #
-      def write_move_with_cells
-        @writer.empty_tag('x:MoveWithCells')
-      end
-
-      #
-      # Write the <x:SizeWithCells> element.
-      #
-      def write_size_with_cells
-        @writer.empty_tag('x:SizeWithCells')
-      end
-
-      #
-      # Write the <x:Visible> element.
-      #
-      def write_visible
-        @writer.empty_tag('x:Visible')
-      end
-
-      #
-      # Write the <x:Anchor> element.
-      #
-      def write_anchor(vertices)
-        col_start, row_start, x1, y1, col_end, row_end, x2, y2 = vertices
-        data = [col_start, x1, row_start, y1, col_end, x2, row_end, y2].join(', ')
-
-        @writer.data_element('x:Anchor', data)
-      end
-
-      #
-      # Write the <x:AutoFill> element.
-      #
-      def write_auto_fill
-        data = 'False'
-
-        @writer.data_element('x:AutoFill', data)
-      end
-
-      #
-      # Write the <x:Row> element.
-      #
-      def write_row(data)
-        @writer.data_element('x:Row', data)
-      end
-
-      #
-      # Write the <x:Column> element.
-      #
-      def write_column(data)
-        @writer.data_element('x:Column', data)
-      end
-
-      #
-      # Write the <x:PrintObject> element.
-      #
-      def write_print_object
-        @writer.data_element('x:PrintObject', 'False')
-      end
-
-      #
-      # Write the <x:TextHAlign> element.
-      #
-      def write_text_halign
-        @writer.data_element('x:TextHAlign', 'Center')
-      end
-
-      #
-      # Write the <x:TextVAlign> element.
-      #
-      def write_text_valign
-        @writer.data_element('x:TextVAlign', 'Center')
-      end
-
-      #
-      # Write the <x:FmlaMacro> element.
-      #
-      def write_fmla_macro(data)
-        @writer.data_element('x:FmlaMacro', data)
-      end
     end
   end
 end

data/lib/write_xlsx/utility.rb

@@ -357,5 +357,143 @@ module Writexlsx
       @dim_colmin = col if !@dim_colmin || (col < @dim_colmin)
       @dim_colmax = col if !@dim_colmax || (col > @dim_colmax)
     end
+
+    def float_to_str(float)
+      return '' unless float
+      if float == float.to_i
+        float.to_i.to_s
+      else
+        float.to_s
+      end
+    end
+
+    #
+    # Convert vertices from pixels to points.
+    #
+    def pixels_to_points(vertices)
+      col_start, row_start, x1,    y1,
+      col_end,   row_end,   x2,    y2,
+      left,      top,       width, height  = vertices.flatten
+
+      left   *= 0.75
+      top    *= 0.75
+      width  *= 0.75
+      height *= 0.75
+
+      [left, top, width, height]
+    end
+
+    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,
+      ]
+    end
+
+    def v_shape_style_base(z_index, vertices)
+      left, top, width, height = pixels_to_points(vertices)
+
+      left_str    = float_to_str(left)
+      top_str     = float_to_str(top)
+      width_str   = float_to_str(width)
+      height_str  = float_to_str(height)
+      z_index_str = float_to_str(z_index)
+
+      shape_style_base(left_str, top_str, width_str, height_str, z_index_str)
+    end
+
+    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, ';'
+      ]
+    end
+
+    #
+    # Write the <v:fill> element.
+    #
+    def write_fill
+      @writer.empty_tag('v:fill', fill_attributes)
+    end
+
+    #
+    # Write the <v:path> element.
+    #
+    def write_comment_path(gradientshapeok, connecttype)
+      attributes      = []
+
+      attributes << 'gradientshapeok' << 't' if gradientshapeok
+      attributes << 'o:connecttype' << connecttype
+
+      @writer.empty_tag('v:path', attributes)
+    end
+
+    #
+    # Write the <x:Anchor> element.
+    #
+    def write_anchor
+      col_start, row_start, x1, y1, col_end, row_end, x2, y2 = vertices
+      data = [col_start, x1, row_start, y1, col_end, x2, row_end, y2].join(', ')
+
+      @writer.data_element('x:Anchor', data)
+    end
+
+    #
+    # Write the <x:AutoFill> element.
+    #
+    def write_auto_fill
+      @writer.data_element('x:AutoFill', 'False')
+    end
+
+    #
+    # Write the <div> element.
+    #
+    def write_div(align, font = nil)
+      style = "text-align:#{align}"
+      attributes = ['style', style]
+
+      @writer.tag_elements('div', attributes) do
+        if font
+          # Write the font element.
+          write_font(font)
+        end
+      end
+    end
+
+    #
+    # Write the <font> element.
+    #
+    def write_font(font)
+      caption = font[:_caption]
+      face    = 'Calibri'
+      size    = 220
+      color   = '#000000'
+
+      attributes = [
+                    'face',  face,
+                    'size',  size,
+                    'color', color
+                   ]
+      @writer.data_element('font', caption, attributes)
+    end
+
+    #
+    # Write the <v:stroke> element.
+    #
+    def write_stroke
+      attributes = ['joinstyle', 'miter']
+
+      @writer.empty_tag('v:stroke', attributes)
+    end
   end
 end

data/lib/write_xlsx/version.rb

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

data/lib/write_xlsx/workbook.rb

@@ -870,8 +870,8 @@ module Writexlsx
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
     #
-    def shared_string_index(str) #:nodoc:
-      @shared_strings.index(str)
+    def shared_string_index(str, params = {}) #:nodoc:
+      @shared_strings.index(str, params)
     end
 
     def str_unique