write_xlsx 0.58.0 → 0.59.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = write_xlsx
 
-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.51, https://github.com/jmcnamara/excel-writer-xlsx .
+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.58, https://github.com/jmcnamara/excel-writer-xlsx .
 
 == Description
 
@@ -74,6 +74,12 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
   workbook.close
 
 == Recent change
+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
+ and macros can be called by the user but they cannot, currently,
+ be linked to form elements such as buttons.
+
 2013-02-10 v0.58.0
  Added chart area and plot area formatting.
 

data/bin/extract_vba.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'zip/zipfilesystem'
+require 'fileutils'
+
+  # src  zip filename
+  # dest  destination directory
+  # options :fs_encoding=[UTF-8,Shift_JIS,EUC-JP]
+  def extract_vba_project(src, dest, options = {})
+    FileUtils.makedirs(dest)
+    Zip::ZipInputStream.open(src) do |is|
+      loop do
+        entry = is.get_next_entry()
+        break if entry.nil?()
+        if entry.name == 'xl/vbaProject.bin'
+          path = File.join(dest, 'vbaProject.bin')
+          File.open(path, File::CREAT|File::WRONLY|File::BINARY) do |w|
+            w.puts(is.read())
+          end
+          break
+        end
+      end
+    end
+  end
+
+  # main
+
+  extract_vba_project('add_vba_project.xlsm', './')

data/examples/add_vba_project.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# An example of adding macros to an Excel::Writer::XLSX file using
+# a VBA project file extracted from an existing Excel xlsm file.
+#
+# The C<extract_vba> utility supplied with Excel::Writer::XLSX can be
+# used to extract the vbaProject.bin file.
+#
+# reverse('(c)'), November 2012, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+# Note the file extension should be .xlsm.
+workbook  = WriteXLSX.new('add_vba_project.xlsm')
+worksheet = workbook.add_worksheet
+
+worksheet.set_column('A:A', 50)
+
+# Add the VBA project binary.
+workbook.add_vba_project(File.join(File.dirname(__FILE__), 'vbaProject.bin'))
+
+# Show text for the end user.
+worksheet.write('A1', 'Run the SampleMacro embedded in this file.')
+worksheet.write('A2', 'You may have to turn on the Excel Developer option first.')
+
+# Call a user defined function from the VBA project.
+worksheet.write('A6', 'Result from a user defined function:')
+worksheet.write('B6', '=MyFunction(7)')
+
+workbook.close

data/lib/write_xlsx/chart.rb

@@ -2111,7 +2111,8 @@ module Writexlsx
     end
 
     #
-    # Write the <c:valAx> element. This is for the second valAx in scatter plots.
+    # Write the <c:valAx> element.
+    # This is for the second valAx in scatter plots.
     #
     # Usually the X axis.
     #
@@ -2528,33 +2529,27 @@ module Writexlsx
     # Write the <c:majorGridlines> element.
     #
     def write_major_gridlines(gridlines) # :nodoc:
-      return unless gridlines
-      return unless ptrue?(gridlines[:_visible])
-
-      if gridlines[:_line] && ptrue?(gridlines[:_line][:_defined])
-        @writer.tag_elements('c:majorGridlines') do
-          # Write the c:spPr element.
-          write_sp_pr(gridlines)
-        end
-      else
-        @writer.empty_tag('c:majorGridlines')
-      end
+      write_gridlines_common(gridlines, 'c:majorGridlines')
     end
 
     #
     # Write the <c:minorGridlines> element.
     #
     def write_minor_gridlines(gridlines)  # :nodoc:
+      write_gridlines_common(gridlines, 'c:minorGridlines')
+    end
+
+    def write_gridlines_common(gridlines, tag)  # :nodoc:
       return unless gridlines
       return unless ptrue?(gridlines[:_visible])
 
       if gridlines[:_line] && ptrue?(gridlines[:_line][:_defined])
-        @writer.tag_elements('c:minorGridlines') do
+        @writer.tag_elements(tag) do
           # Write the c:spPr element.
           write_sp_pr(gridlines)
         end
       else
-        @writer.empty_tag('c:minorGridlines')
+        @writer.empty_tag(tag)
       end
     end
 
@@ -2880,22 +2875,10 @@ module Writexlsx
     # Write the <a:defRPr> element.
     #
     def write_a_def_rpr(font = nil) # :nodoc:
-      style_attributes = get_font_style_attributes(font)
-      latin_attributes = get_font_latin_attributes(font)
-      has_color = ptrue?(font) && ptrue?(font[:_color])
-
-      if !latin_attributes.empty? || has_color
-        @writer.tag_elements('a:defRPr', 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('a:defRPr', style_attributes)
-      end
+      write_def_rpr_r_pr_common(
+                                font,
+                                get_font_style_attributes(font),
+                                'a:defRPr')
     end
 
     #
@@ -2925,17 +2908,19 @@ module Writexlsx
     # Write the <a:rPr> element.
     #
     def write_a_r_pr(font) # :nodoc:
-      lang = 'en-US'
+      write_def_rpr_r_pr_common(
+                                font,
+                                get_font_style_attributes(font).unshift('en-US').unshift('lang'),
+                                'a:rPr'
+                                )
+    end
 
-      style_attributes = get_font_style_attributes(font)
+    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])
 
-      # Add the lang type to the attributes.
-      style_attributes.unshift(lang).unshift('lang')
-
       if !latin_attributes.empty? || has_color
-        @writer.tag_elements('a:rPr', style_attributes) do
+        @writer.tag_elements(tag, style_attributes) do
           if has_color
             write_a_solid_fill(:color => font[:_color])
           end
@@ -2944,7 +2929,7 @@ module Writexlsx
           end
         end
       else
-        @writer.empty_tag('a:rPr', style_attributes)
+        @writer.empty_tag(tag, style_attributes)
       end
     end