write_xlsx 0.59.0 → 0.60.0

data/README.rdoc

@@ -32,7 +32,7 @@ write_xlsx uses the same interface as writeexcel gem.
 
 Add this line to your application's Gemfile:
 
-    gem 'writeexcel'
+    gem 'write_xlsx'
 
 And then execute:
 
@@ -40,7 +40,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install writeexcel
+    $ gem install write_xlsx
 
 == Synopsis
 
@@ -74,6 +74,15 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
   workbook.close
 
 == Recent change
+2013-02-19 v0.60.0
+ Added Excel form buttons via the worksheet insert_button() method.
+ This allows the user to tie the button to an embedded macro imported
+ using add_vba_project().
+ The portal to the dungeon dimensions is now fully open.
+
+ bug fix in Worksheet#write_url
+ bug fix in bin/vba_extract.rb
+
 2013-02-17 v0.59.0
  Added macro support via VBA projects extracted from existing Excel
  xlsm files. User defined functions can be called from worksheets

data/bin/extract_vba.rb

@@ -18,6 +18,11 @@ def extract_vba_project(src, dest, options = {})
           File.open(path, File::CREAT|File::WRONLY|File::BINARY) do |w|
             w.puts(is.read())
           end
+          # The mod data on vbaProject.bin isn't generally set correctly in the
+          # xlsm/zip file. This can cause issues on Windows so reset it to the
+          # current data.
+          ctime = Time.now
+          File::utime(ctime, ctime, path)
           break
         end
       end

data/lib/write_xlsx/package/comments.rb

@@ -167,8 +167,6 @@ def assemble_xml_file
       end
 
       def sorted_comments
-        @sorted_comments if @sorted_comments
-
         @sorted_comments = []
         # We sort the comments by row and column but that isn't strictly required.
         @comments.keys.sort.each do |row|

data/lib/write_xlsx/package/packager.rb

@@ -42,6 +42,7 @@ def add_workbook(workbook)
         @sheet_names       = workbook.sheetnames
         @chart_count       = workbook.charts.size
         @drawing_count     = workbook.drawings.size
+        @num_vml_files     = workbook.num_vml_files
         @num_comment_files = workbook.num_comment_files
         @named_ranges      = workbook.named_ranges
 
@@ -153,7 +154,7 @@ def write_chart_or_drawing_files(objects, filename)
       def write_vml_files
         index = 1
         @workbook.worksheets.each do |worksheet|
-          next unless worksheet.has_comments?
+          next unless worksheet.has_vml?
           FileUtils.mkdir_p("#{@package_dir}/xl/drawings")
 
           vml = Package::Vml.new
@@ -273,7 +274,7 @@ def write_content_types_file
         (1 .. @chart_count).each { |i| content.add_chart_name("chart#{i}") }
         (1 .. @drawing_count).each { |i| content.add_drawing_name("drawing#{i}") }
 
-        content.add_vml_name if @num_comment_files > 0
+        content.add_vml_name if @num_vml_files > 0
 
         (1 .. @table_count).each { |i| content.add_table_name("table#{i}") }
 

data/lib/write_xlsx/package/vml.rb

@@ -23,16 +23,27 @@ def assemble_xml_file(worksheet)
           # Write the o:shapelayout element.
           write_shapelayout(worksheet.vml_data_id)
 
-          # Write the v:shapetype element.
-          write_shapetype
-
           z_index = 1
           vml_shape_id = worksheet.vml_shape_id
-          worksheet.comments_array.each do |comment|
-            # Write the v:shape element.
-            vml_shape_id += 1
-            write_shape(vml_shape_id, z_index, comment)
-            z_index += 1
+          unless worksheet.buttons_data.empty?
+            # Write the v:shapetype element.
+            write_button_shapetype
+            worksheet.buttons_data.each do |button|
+              # Write the v:shape element.
+              vml_shape_id += 1
+              write_button_shape(vml_shape_id, z_index, button)
+              z_index += 1
+            end
+          end
+          unless worksheet.comments_array.empty?
+            # Write the v:shapetype element.
+            write_comment_shapetype
+            worksheet.comments_array.each do |comment|
+              # Write the v:shape element.
+              vml_shape_id += 1
+              write_comment_shape(vml_shape_id, z_index, comment)
+              z_index += 1
+            end
           end
         end
         @writer.crlf
@@ -107,24 +118,40 @@ def write_idmap(data_id)
       #
       # Write the <v:shapetype> element.
       #
-      def write_shapetype
-        id        = '_x0000_t202'
-        coordsize = '21600,21600'
-        spt       = 202
-        path      = 'm,l,21600r21600,l21600,xe'
+      def write_comment_shapetype
+        attributes = [
+            'id',        '_x0000_t202',
+            'coordsize', '21600,21600',
+            'o:spt',     202,
+            'path',      'm,l,21600r21600,l21600,xe'
+        ]
+
+        @writer.tag_elements('v:shapetype', attributes) do
+          # Write the v:stroke element.
+          write_stroke
+          # Write the v:path element.
+          write_comment_path('t', 'rect')
+        end
+      end
 
+      #
+      # Write the <v:shapetype> element.
+      #
+      def write_button_shapetype
         attributes = [
-            'id',        id,
-            'coordsize', coordsize,
-            'o:spt',     spt,
-            'path',      path
+            '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.
           write_stroke
           # Write the v:path element.
-          write_path('t', 'rect')
+          write_button_path
+          # Write the o:lock element.
+          write_shapetype_lock
         end
       end
 
@@ -142,7 +169,7 @@ def write_stroke
       #
       # Write the <v:path> element.
       #
-      def write_path(gradientshapeok, connecttype)
+      def write_comment_path(gradientshapeok, connecttype)
         attributes      = []
 
         attributes << 'gradientshapeok' << 't' if gradientshapeok
@@ -151,10 +178,46 @@ def write_path(gradientshapeok, connecttype)
         @writer.empty_tag('v:path', attributes)
       end
 
+      #
+      # Write the <v:path> element.
+      #
+      def write_button_path
+        attributes = [
+                      'shadowok',      'f',
+                      'o:extrusionok', 'f',
+                      'strokeok',      'f',
+                      'fillok',        'f',
+                      'o:connecttype', 'rect'
+                     ]
+        @writer.empty_tag('v:path', attributes)
+      end
+
+      #
+      # Write the <o:lock> element.
+      #
+      def write_shapetype_lock
+        attributes = [
+                      'v:ext',     'edit',
+                      'shapetype', 't'
+                     ]
+        @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_shape(id, z_index, comment)
+      def write_comment_shape(id, z_index, comment)
         type       = '#_x0000_t202'
         insetmode  = 'auto'
         visibility = 'hidden'
@@ -199,15 +262,68 @@ def write_shape(id, z_index, comment)
 
         @writer.tag_elements('v:shape', attributes) do
           # Write the v:fill element.
-          write_fill
+          write_comment_fill
           # Write the v:shadow element.
           write_shadow
           # Write the v:path element.
-          write_path(nil, 'none')
+          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_textbox
+          write_button_textbox(button[:_font])
           # Write the x:ClientData element.
-          write_client_data(comment)
+          write_button_client_data(button)
         end
       end
 
@@ -223,13 +339,28 @@ def float_to_str(float)
       #
       # Write the <v:fill> element.
       #
-      def write_fill
+      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.
       #
@@ -250,31 +381,67 @@ def write_shadow
       #
       # Write the <v:textbox> element.
       #
-      def write_textbox
+      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
+          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
-        style = 'text-align:left'
+      def write_div(align, font = nil)
+        style = "text-align:#{align}"
         attributes = ['style', style]
 
-        @writer.tag_elements('div', attributes) { }
+        @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_client_data(comment)
+      def write_comment_client_data(comment)
         object_type = 'Note'
 
         attributes = ['ObjectType', object_type]
@@ -297,6 +464,30 @@ def write_client_data(comment)
         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.
       #
@@ -350,6 +541,34 @@ def write_row(data)
       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