write_xlsx 0.0.4 → 0.51.0

data/lib/write_xlsx/package/table.rb

@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class Table
+      include Writexlsx::Utility
+
+      attr_writer :properties
+
+      def initialize
+        @writer = Package::XMLWriterSimple.new
+        @properties = {}
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      #
+      # Assemble and writes the XML file.
+      #
+      def assemble_xml_file
+        write_xml_declaration
+        # Write the table element.
+        write_table
+        # Write the autoFilter element.
+        write_auto_filter
+        # Write the tableColumns element.
+        write_table_columns
+        # Write the tableStyleInfo element.
+        write_table_style_info
+
+        # Close the table tag
+        @writer.end_tag('table')
+
+        # Close the XML writer object and filehandle.
+        @writer.crlf
+        @writer.close
+      end
+
+      #
+      # Set the document properties.
+      #
+      def set_properties(properties)
+        @properties = properties
+      end
+
+      private
+
+      #
+      # Write the XML declaration.
+      #
+      def write_xml_declaration
+        @writer.xml_decl('UTF-8', 1)
+      end
+
+      #
+      # Write the <autoFilter> element.
+      #
+      def write_auto_filter
+        autofilter = @properties[:_autofilter]
+
+        return unless autofilter
+
+        attributes = ['ref', autofilter]
+
+        @writer.empty_tag('autoFilter', attributes)
+      end
+
+      #
+      # Write the <table> element.
+      #
+      def write_table
+        schema           = 'http://schemas.openxmlformats.org/'
+        xmlns            = "#{schema}spreadsheetml/2006/main"
+        id               = @properties[:id]
+        name             = @properties[:_name]
+        display_name     = @properties[:_name]
+        ref              = @properties[:_range]
+        totals_row_shown = @properties[:_totals_row_shown]
+        header_row_count = @properties[:_header_row_count]
+
+        attributes = [
+                      'xmlns',       xmlns,
+                      'id',          id,
+                      'name',        name,
+                      'displayName', display_name,
+                      'ref',         ref
+                     ]
+
+        unless ptrue?(header_row_count)
+          attributes << 'headerRowCount' << 0
+        end
+
+        if ptrue?(totals_row_shown)
+          attributes << 'totalsRowCount' << 1
+        else
+          attributes << 'totalsRowShown' << 0
+        end
+        @writer.start_tag('table', attributes)
+      end
+
+      #
+      # Write the <autoFilter> element.
+      #
+      def write_auto_filter
+        autofilter = @properties[:_autofilter]
+
+        return unless ptrue?(autofilter)
+
+        attributes = ['ref', autofilter]
+
+        @writer.empty_tag('autoFilter', attributes)
+      end
+
+      #
+      # Write the <tableColumns> element.
+      #
+      def write_table_columns
+        columns = @properties[:_columns]
+
+        count = columns.size
+
+        attributes = ['count', count]
+
+        @writer.tag_elements('tableColumns', attributes) do
+          columns.each {|col_data| write_table_column(col_data)}
+        end
+      end
+
+      #
+      # Write the <tableColumn> element.
+      #
+      def write_table_column(col_data)
+        attributes = [
+                      'id',   col_data[:_id],
+                      'name', col_data[:_name]
+                     ]
+
+        if ptrue?(col_data[:_total_string])
+          attributes << :totalsRowLabel << col_data[:_total_string]
+        elsif ptrue?(col_data[:_total_function])
+          attributes << :totalsRowFunction << col_data[:_total_function]
+        end
+
+        if col_data[:_format]
+          attributes << :dataDxfId << col_data[:_format]
+        end
+
+        if ptrue?(col_data[:_formula])
+          @writer.tag_elements('tableColumn', attributes) do
+            # Write the calculatedColumnFormula element.
+            write_calculated_column_formula(col_data[:_formula])
+          end
+        else
+          @writer.empty_tag('tableColumn', attributes)
+        end
+      end
+
+      #
+      # Write the <tableStyleInfo> element.
+      #
+      def write_table_style_info
+        props = @properties
+
+        name                = props[:_style]
+        show_first_column   = props[:_show_first_col]
+        show_last_column    = props[:_show_last_col]
+        show_row_stripes    = props[:_show_row_stripes]
+        show_column_stripes = props[:_show_col_stripes]
+
+        attributes = [
+                      'name',              name,
+                      'showFirstColumn',   show_first_column,
+                      'showLastColumn',    show_last_column,
+                      'showRowStripes',    show_row_stripes,
+                      'showColumnStripes', show_column_stripes
+                     ]
+
+        @writer.empty_tag('tableStyleInfo', attributes)
+      end
+
+      #
+      # Write the <calculatedColumnFormula> element.
+      #
+      def write_calculated_column_formula(formula)
+        @writer.data_element('calculatedColumnFormula', formula)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/vml.rb

@@ -19,24 +19,22 @@ def set_xml_writer(filename)
       def assemble_xml_file(worksheet)
         return unless @writer
 
-        write_xml_namespace
-
-        # 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
+        write_xml_namespace do
+          # 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
+          end
         end
-
-        @writer.end_tag('xml')
         @writer.crlf
         @writer.close
       end
@@ -63,18 +61,19 @@ def pixels_to_points(vertices)
       # Write the <xml> element. This is the root element of VML.
       #
       def write_xml_namespace
-        schema  = 'urn:schemas-microsoft-com:'
-        xmlns   = schema + 'vml'
-        xmlns_o = schema + 'office:office'
-        xmlns_x = schema + 'office:excel'
+        @writer.tag_elements('xml', xml_attributes) do
+          yield
+        end
+      end
 
-        attributes = [
-          'xmlns:v', xmlns,
-          'xmlns:o', xmlns_o,
-          'xmlns:x', xmlns_x
+      # for <xml> elements.
+      def xml_attributes
+        schema  = 'urn:schemas-microsoft-com:'
+        [
+         'xmlns:v', "#{schema}vml",
+         'xmlns:o', "#{schema}office:office",
+         'xmlns:x', "#{schema}office:excel"
         ]
-
-        @writer.start_tag('xml', attributes)
       end
 
       #

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -43,12 +43,31 @@ def empty_tag(tag, attr = [])
         io_write(str)
       end
 
+      def empty_tag_encoded(tag, attr = [])
+        str = "<#{tag}#{key_vals(attr)} />"
+        io_write(str)
+      end
+
       def data_element(tag, data, attr = [])
-        tag_elements(tag, attr) { io_write("#{characters(data)}") }
+        tag_elements(tag, attr) { io_write("#{escape_xml_chars(data)}") }
+      end
+
+      #
+      # Optimised tag writer ?  for shared strings <si> elements.
+      #
+      def si_element(data, attr)
+        tag_elements('si') { data_element('t', data, attr) }
+      end
+
+      #
+      # Optimised tag writer for shared strings <si> rich string elements.
+      #
+      def si_rich_element(data)
+        io_write("<si>#{data}</si>")
       end
 
       def characters(data)
-        escape_xml_chars(data)
+        io_write(escape_xml_chars(data))
       end
 
       def crlf
@@ -84,8 +103,10 @@ def key_vals(attr)
 
       def escape_xml_chars(str = '')
         if str =~ /[&<>"]/
-          str.gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;').gsub(/"/, '&quot;')
-        else
+          str.gsub(/&/, '&amp;').
+            gsub(/</, '&lt;').
+            gsub(/>/, '&gt;')
+         else
           str
         end
       end

data/lib/write_xlsx/shape.rb

@@ -0,0 +1,172 @@
+# -*- coding: utf-8 -*-
+
+module Writexlsx
+  ###############################################################################
+  #
+  # Shape - A class for writing Excel shapes.
+  #
+  # Used in conjunction with Excel::Writer::XLSX.
+  #
+  # Copyright 2000-2012, John McNamara, jmcnamara@cpan.org
+  # Converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+  #
+  class Shape
+
+    attr_reader :connect, :editAs, :type, :start, :start_index, :end, :end_index
+    attr_reader :tx_box, :fill, :rotation, :flip_h, :flip_v
+    attr_accessor :name
+
+    def initialize(properties = {})
+      @writer = Package::XMLWriterSimple.new
+      @name   = nil
+      @type   = 'rect'
+
+      # Is a Connector shape. 1/0 Value is a hash lookup from type.
+      @connect = 0
+
+      # Is a Drawing. Always 0, since a single shape never fills an entire sheet.
+      @drawing = 0
+
+      # OneCell or Absolute: options to move and/or size with cells.
+      @editAs = ''
+
+      # Auto-incremented, unless supplied by user.
+      @id = 0
+
+      # Shape text (usually centered on shape geometry).
+      @text = 0
+
+      # Shape stencil mode.  A copy (child) is created when inserted.
+      # The link to parent is broken.
+      @stencil = 1
+
+      # Index to _shapes array when inserted.
+      @element = -1
+
+      # Shape ID of starting connection, if any.
+      @start = nil
+
+      # Shape vertex, starts at 0, numbered clockwise from 12 o'clock.
+      @start_index = nil
+
+      @end       = nil
+      @end_index = nil
+
+      # Number and size of adjustments for shapes (usually connectors).
+      @adjustments = []
+
+      # Start and end sides. t)op, b)ottom, l)eft, or r)ight.
+      @start_side = ''
+      @end_side   = ''
+
+      # Flip shape Horizontally. eg. arrow left to arrow right.
+      @flip_h = 0
+
+      # Flip shape Vertically. eg. up arrow to down arrow.
+      @flip_v = 0
+
+      # shape rotation (in degrees 0-360).
+      @rotation = 0
+
+      # An alternate way to create a text box, because Excel allows it.
+      # It is just a rectangle with text.
+      @tx_box = 0
+
+      # Shape outline colour, or 0 for noFill (default black).
+      @line = '000000'
+
+      # Line type: dash, sysDot, dashDot, lgDash, lgDashDot, lgDashDotDot.
+      @line_type = ''
+
+      # Line weight (integer).
+      @line_weight = 1
+
+      # Shape fill colour, or 0 for noFill (default noFill).
+      @fill = 0
+
+      # Formatting for shape text, if any.
+      @format = {}
+
+      # copy of colour palette table from Workbook.pm.
+      @palette = []
+
+      # Vertical alignment: t, ctr, b.
+      @valign = 'ctr'
+
+      # Alignment: l, ctr, r, just
+      @align = 'ctr'
+
+      @x_offset = 0
+      @y_offset = 0
+
+      # Scale factors, which also may be set when the shape is inserted.
+      @scale_x = 1
+      @scale_y = 1
+
+      # Default size, which can be modified and/or scaled.
+      @width  = 50
+      @height = 50
+
+      # Initial assignment. May be modified when prepared.
+      @column_start = 0
+      @row_start    = 0
+      @x1           = 0
+      @y1           = 0
+      @column_end   = 0
+      @row_end      = 0
+      @x2           = 0
+      @y2           = 0
+      @x_abs        = 0
+      @y_abs        = 0
+
+      set_properties(properties)
+    end
+
+    def set_properties(properties)
+      # Override default properties with passed arguments
+      properties.each do |key, value|
+        # Strip leading "-" from Tk style properties e.g. -color => 'red'.
+        k = key.to_s.sub(/^-/, '')
+        self.instance_variable_set("@#{key}", value)
+=begin
+           if key.to_s == 'format'
+          @format = value
+        elsif value.respond_to?(:coerce)
+          eval "@#{k} = #{value}"
+        else
+          eval "@#{k} = %!#{value}!"
+        end
+=end
+      end
+    end
+
+    #
+    # Set the shape adjustments array (as a reference).
+    #
+    def adjustments=(args)
+      @adjustments = *args
+    end
+
+    def [](attr)
+      self.instance_variable_get("@#{attr}")
+    end
+
+    def []=(attr, value)
+      self.instance_variable_set("@#{attr}", value)
+    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
+  end
+end