write_xlsx 0.0.2

data/lib/write_xlsx/colors.rb

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+
+module Writexlsx
+  class Colors
+    COLORS = {
+      :aqua    => 0x0F,
+      :cyan    => 0x0F,
+      :black   => 0x08,
+      :blue    => 0x0C,
+      :brown   => 0x10,
+      :magenta => 0x0E,
+      :fuchsia => 0x0E,
+      :gray    => 0x17,
+      :grey    => 0x17,
+      :green   => 0x11,
+      :lime    => 0x0B,
+      :navy    => 0x12,
+      :orange  => 0x35,
+      :pink    => 0x21,
+      :purple  => 0x14,
+      :red     => 0x0A,
+      :silver  => 0x16,
+      :white   => 0x09,
+      :yellow  => 0x0D,
+    }   # :nodoc:
+
+    ###############################################################################
+    #
+    # get_color(colour)
+    #
+    # Used in conjunction with the set_xxx_color methods to convert a color
+    # string into a number. Color range is 0..63 but we will restrict it
+    # to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
+    #
+    def get_color(color = nil) # :nodoc:
+      if color.respond_to?(:to_int) && color.respond_to?(:+)
+        # the default color if arg is outside range,
+        if color < 0 || 63 < color
+          0x7FFF
+        # or an index < 8 mapped into the correct range,
+        elsif color < 8
+          (color + 8).to_i
+        # or an integer in the valid range
+        else
+          color.to_i
+        end
+      elsif color.respond_to?(:to_sym)
+        color = color.downcase.to_sym if color.respond_to?(:to_str)
+        # or the color string converted to an integer,
+        if COLORS.has_key?(color)
+          COLORS[color]
+        # or the default color if string is unrecognised,
+        else
+          0x7FFF
+        end
+      else
+        0x7FFF
+      end
+    end
+
+    def inspect
+      to_s
+    end
+  end  # class Colors
+end

data/lib/write_xlsx/compatibility.rb

@@ -0,0 +1,71 @@
+# coding: utf-8
+#
+# Why would we ever use Ruby 1.8.7 when we can backport with something
+# as simple as this?
+#
+# copied from prawn.
+# modified by Hideo NAKAMURA
+#
+class String #:nodoc:
+  def first_line
+    self.each_line { |line| return line }
+  end
+  unless "".respond_to?(:lines)
+    alias_method :lines, :to_a
+  end
+  unless "".respond_to?(:each_char)
+    def each_char #:nodoc:
+      # copied from jcode
+      if block_given?
+        scan(/./m) { |x| yield x }
+      else
+        scan(/./m)
+      end
+    end
+  end
+
+  unless "".respond_to?(:bytesize)
+    def bytesize # :nodoc:
+      self.length
+    end
+  end
+
+  unless "".respond_to?(:ord)
+    def ord
+      self[0]
+    end
+  end
+
+  unless "".respond_to?(:ascii_only?)
+    def ascii_only?
+      !!(self =~ /[^!"#\$%&'\(\)\*\+,\-\.\/\:\;<=>\?@0-9A-Za-z_\[\\\]\{\}^` ~\0\n]/)
+    end
+  end
+end
+
+unless File.respond_to?(:binread)
+  def File.binread(file) #:nodoc:
+    File.open(file,"rb") { |f| f.read }
+  end
+end
+
+if RUBY_VERSION < "1.9"
+
+  def ruby_18 #:nodoc:
+    yield
+  end
+
+  def ruby_19 #:nodoc:
+    false
+  end
+
+else
+
+  def ruby_18 #:nodoc:
+    false
+  end
+
+  def ruby_19 #:nodoc:
+    yield
+  end
+end

data/lib/write_xlsx/drawing.rb

@@ -0,0 +1,547 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple.rb'
+
+module Writexlsx
+  class Drawing
+    attr_writer :embedded
+
+    def initialize
+      @writer = Package::XMLWriterSimple.new
+      @drawings    = []
+      @embedded    = false
+      @orientation = false
+    end
+
+    def xml_str
+      @writer.string
+    end
+
+    def set_xml_writer(filename)
+      @writer.set_xml_writer(filename)
+    end
+
+    #
+    # Assemble and write the XML file.
+    #
+    def assemble_xml_file
+      @writer.xml_decl
+
+      # Write the xdr:wsDr element.
+      write_drawing_workspace
+
+      if @embedded
+          index = 0
+          @drawings.each do |dimensions|
+            # Write the xdr:twoCellAnchor element.
+            index += 1
+
+            write_two_cell_anchor(index, *(dimensions.flatten))
+          end
+      else
+        index = 0
+
+        # Write the xdr:absoluteAnchor element.
+        index += 1
+        write_absolute_anchor(index)
+      end
+
+      @writer.end_tag('xdr:wsDr')
+      @writer.crlf
+      @writer.close
+    end
+
+    #
+    # Add a chart or image sub object to the drawing.
+    #
+    def add_drawing_object(*args)
+      @drawings << args
+    end
+
+    private
+
+    #
+    # Write the <xdr:wsDr> element.
+    #
+    def write_drawing_workspace
+      schema    = 'http://schemas.openxmlformats.org/drawingml/'
+      xmlns_xdr = "#{schema}2006/spreadsheetDrawing"
+      xmlns_a   = "#{schema}2006/main"
+
+      attributes = [
+          'xmlns:xdr', xmlns_xdr,
+          'xmlns:a',   xmlns_a
+      ]
+
+      @writer.start_tag('xdr:wsDr', attributes)
+    end
+
+    #
+    # Write the <xdr:twoCellAnchor> element.
+    #
+    def write_two_cell_anchor(*args)
+      index, type, col_from, row_from, col_from_offset, row_from_offset,
+      col_to, row_to, col_to_offset, row_to_offset, col_absolute, row_absolute,
+      width, height, description = args
+
+      attributes      = []
+
+      # Add attribute for images.
+      attributes << :editAs << 'oneCell' if type == 2
+
+      @writer.start_tag('xdr:twoCellAnchor', attributes)
+
+      # Write the xdr:from element.
+      write_from(col_from, row_from, col_from_offset, row_from_offset)
+
+      # Write the xdr:from element.
+      write_to(col_to, row_to, col_to_offset, row_to_offset)
+
+      if type == 1
+        # Write the xdr:graphicFrame element for charts.
+        write_graphic_frame(index)
+      else
+        # Write the xdr:pic element.
+        write_pic(index, col_absolute, row_absolute, width, height, description)
+      end
+
+      # Write the xdr:clientData element.
+      write_client_data
+
+      @writer.end_tag('xdr:twoCellAnchor')
+    end
+
+    #
+    # Write the <xdr:from> element.
+    #
+    def write_from(col, row, col_offset, row_offset)
+      @writer.start_tag('xdr:from')
+
+      # Write the xdr:col element.
+      write_col(col)
+
+      # Write the xdr:colOff element.
+      write_col_off(col_offset)
+
+      # Write the xdr:row element.
+      write_row(row)
+
+      # Write the xdr:rowOff element.
+      write_row_off(row_offset)
+
+      @writer.end_tag('xdr:from')
+    end
+
+    #
+    # Write the <xdr:to> element.
+    #
+    def write_to(col, row, col_offset, row_offset)
+      @writer.start_tag('xdr:to')
+
+      # Write the xdr:col element.
+      write_col(col)
+
+      # Write the xdr:colOff element.
+      write_col_off(col_offset)
+
+      # Write the xdr:row element.
+      write_row(row)
+
+      # Write the xdr:rowOff element.
+      write_row_off(row_offset)
+
+      @writer.end_tag('xdr:to')
+    end
+
+    #
+    # Write the <xdr:col> element.
+    #
+    def write_col(data)
+      @writer.data_element('xdr:col', data)
+    end
+
+    #
+    # Write the <xdr:colOff> element.
+    #
+    def write_col_off(data)
+      @writer.data_element('xdr:colOff', data)
+    end
+
+
+    #
+    # Write the <xdr:row> element.
+    #
+    def write_row(data)
+      @writer.data_element('xdr:row', data)
+    end
+
+
+    #
+    # Write the <xdr:rowOff> element.
+    #
+    def write_row_off(data)
+      @writer.data_element('xdr:rowOff', data)
+    end
+
+    #
+    # Write the <xdr:graphicFrame> element.
+    #
+    def write_graphic_frame(index)
+      macro  = ''
+
+      attributes = ['macro', macro]
+
+      @writer.start_tag('xdr:graphicFrame', attributes)
+
+      # Write the xdr:nvGraphicFramePr element.
+      write_nv_graphic_frame_pr(index)
+
+      # Write the xdr:xfrm element.
+      write_xfrm
+
+      # Write the a:graphic element.
+      write_atag_graphic(index)
+
+      @writer.end_tag('xdr:graphicFrame')
+    end
+
+    #
+    # Write the <xdr:nvGraphicFramePr> element.
+    #
+    def write_nv_graphic_frame_pr(index)
+      @writer.start_tag('xdr:nvGraphicFramePr')
+
+      # Write the xdr:cNvPr element.
+      write_c_nv_pr( index + 1, "Chart #{index}" )
+
+      # Write the xdr:cNvGraphicFramePr element.
+      write_c_nv_graphic_frame_pr
+
+      @writer.end_tag('xdr:nvGraphicFramePr')
+    end
+
+    #
+    # Write the <xdr:cNvPr> element.
+    #
+    def write_c_nv_pr(id, name, descr = nil)
+      attributes = [
+          'id',   id,
+          'name', name
+      ]
+
+      # Add description attribute for images.
+      attributes << 'descr' << descr if descr
+
+      @writer.empty_tag('xdr:cNvPr', attributes)
+    end
+
+
+    #
+    # Write the <xdr:cNvGraphicFramePr> element.
+    #
+    def write_c_nv_graphic_frame_pr
+      if @embedded
+        @writer.empty_tag('xdr:cNvGraphicFramePr')
+      else
+        @writer.start_tag('xdr:cNvGraphicFramePr')
+
+        # Write the a:graphicFrameLocks element.
+        write_a_graphic_frame_locks
+
+        @writer.end_tag('xdr:cNvGraphicFramePr')
+      end
+    end
+
+    #
+    # Write the <a:graphicFrameLocks> element.
+    #
+    def write_a_graphic_frame_locks
+      no_grp = 1
+
+      attributes = ['noGrp', no_grp ]
+
+      @writer.empty_tag('a:graphicFrameLocks', attributes)
+    end
+
+    #
+    # Write the <xdr:xfrm> element.
+    #
+    def write_xfrm
+      @writer.start_tag('xdr:xfrm')
+
+      # Write the xfrmOffset element.
+      write_xfrm_offset
+
+      # Write the xfrmOffset element.
+      write_xfrm_extension
+
+      @writer.end_tag('xdr:xfrm')
+    end
+
+    #
+    # Write the <a:off> xfrm sub-element.
+    #
+    def write_xfrm_offset
+      x    = 0
+      y    = 0
+
+      attributes = [
+        'x', x,
+        'y', y
+      ]
+
+      @writer.empty_tag('a:off', attributes)
+    end
+
+    #
+    # Write the <a:ext> xfrm sub-element.
+    #
+    def write_xfrm_extension
+      x    = 0
+      y    = 0
+
+      attributes = [
+        'cx', x,
+        'cy', y
+      ]
+
+      @writer.empty_tag('a:ext', attributes)
+    end
+
+    #
+    # Write the <a:graphic> element.
+    #
+    def write_atag_graphic(index)
+      @writer.start_tag('a:graphic')
+
+      # Write the a:graphicData element.
+      write_atag_graphic_data(index)
+
+      @writer.end_tag('a:graphic')
+    end
+
+    #
+    # Write the <a:graphicData> element.
+    #
+    def write_atag_graphic_data(index)
+      uri   = 'http://schemas.openxmlformats.org/drawingml/2006/chart'
+
+      attributes = ['uri', uri]
+
+      @writer.start_tag('a:graphicData', attributes)
+
+      # Write the c:chart element.
+      write_c_chart("rId#{index}")
+
+      @writer.end_tag('a:graphicData')
+    end
+
+    #
+    # Write the <c:chart> element.
+    #
+    def write_c_chart(r_id)
+      schema  = 'http://schemas.openxmlformats.org/'
+      xmlns_c = "#{schema}drawingml/2006/chart"
+      xmlns_r = "#{schema}officeDocument/2006/relationships"
+
+
+      attributes = [
+        'xmlns:c', xmlns_c,
+        'xmlns:r', xmlns_r,
+        'r:id',    r_id
+      ]
+
+      @writer.empty_tag('c:chart', attributes)
+    end
+
+    #
+    # Write the <xdr:clientData> element.
+    #
+    def write_client_data
+      @writer.empty_tag('xdr:clientData')
+    end
+
+    #
+    # Write the <xdr:pic> element.
+    #
+    def write_pic(index, col_absolute, row_absolute, width, height, description)
+      @writer.start_tag('xdr:pic')
+
+      # Write the xdr:nvPicPr element.
+      write_nv_pic_pr(index, description)
+
+      # Write the xdr:blipFill element.
+      write_blip_fill(index)
+
+      # Write the xdr:spPr element.
+      write_sp_pr(col_absolute, row_absolute, width, height)
+
+      @writer.end_tag('xdr:pic')
+    end
+
+    #
+    # Write the <xdr:nvPicPr> element.
+    #
+    def write_nv_pic_pr(index, description)
+      @writer.start_tag('xdr:nvPicPr')
+
+      # Write the xdr:cNvPr element.
+      write_c_nv_pr( index + 1, "Picture #{index}", description )
+
+      # Write the xdr:cNvPicPr element.
+      write_c_nv_pic_pr
+
+      @writer.end_tag('xdr:nvPicPr')
+    end
+
+    #
+    # Write the <xdr:cNvPicPr> element.
+    #
+    def write_c_nv_pic_pr
+      @writer.start_tag('xdr:cNvPicPr')
+
+      # Write the a:picLocks element.
+      write_a_pic_locks
+
+      @writer.end_tag('xdr:cNvPicPr')
+    end
+
+    #
+    # Write the <a:picLocks> element.
+    #
+    def write_a_pic_locks
+      no_change_aspect = 1
+
+      attributes = ['noChangeAspect', no_change_aspect]
+
+      @writer.empty_tag('a:picLocks', attributes)
+    end
+
+    #
+    # Write the <xdr:blipFill> element.
+    #
+    def write_blip_fill(index)
+      @writer.start_tag('xdr:blipFill')
+
+      # Write the a:blip element.
+      write_a_blip(index)
+
+      # Write the a:stretch element.
+      write_a_stretch
+
+      @writer.end_tag('xdr:blipFill')
+    end
+
+    #
+    # Write the <a:blip> element.
+    #
+    def write_a_blip(index)
+      schema  = 'http://schemas.openxmlformats.org/officeDocument/'
+      xmlns_r = "#{schema}2006/relationships"
+      r_embed = "rId#{index}"
+
+      attributes = [
+        'xmlns:r', xmlns_r,
+        'r:embed', r_embed
+      ]
+
+      @writer.empty_tag('a:blip', attributes)
+    end
+
+    #
+    # Write the <a:stretch> element.
+    #
+    def write_a_stretch
+      @writer.start_tag('a:stretch')
+
+      # Write the a:fillRect element.
+      write_a_fill_rect
+
+      @writer.end_tag('a:stretch')
+    end
+
+    #
+    # Write the <a:fillRect> element.
+    #
+    def write_a_fill_rect
+      @writer.empty_tag('a:fillRect')
+    end
+
+    #
+    # Write the <xdr:spPr> element.
+    #
+    def write_sp_pr(col_absolute, row_absolute, width, height)
+      @writer.start_tag('xdr:spPr')
+
+      # Write the a:xfrm element.
+      write_a_xfrm(col_absolute, row_absolute, width, height)
+
+      # Write the a:prstGeom element.
+      write_a_prst_geom
+
+      @writer.end_tag('xdr:spPr')
+    end
+
+    #
+    # Write the <a:xfrm> element.
+    #
+    def write_a_xfrm(col_absolute, row_absolute, width, height)
+      @writer.start_tag('a:xfrm')
+
+      # Write the a:off element.
+      write_a_off( col_absolute, row_absolute )
+
+      # Write the a:ext element.
+      write_a_ext( width, height )
+
+      @writer.end_tag('a:xfrm')
+    end
+
+    #
+    # Write the <a:off> element.
+    #
+    def write_a_off(x, y)
+      attributes = [
+        'x', x,
+        'y', y
+      ]
+
+      @writer.empty_tag('a:off', attributes)
+    end
+
+
+    #
+    # Write the <a:ext> element.
+    #
+    def write_a_ext(cx, cy)
+      attributes = [
+        'cx', cx,
+        'cy', cy
+      ]
+
+      @writer.empty_tag('a:ext', attributes)
+    end
+
+    #
+    # Write the <a:prstGeom> element.
+    #
+    def write_a_prst_geom
+      prst = 'rect'
+
+      attributes = ['prst', prst]
+
+      @writer.start_tag('a:prstGeom', attributes)
+
+      # Write the a:avLst element.
+      write_a_av_lst
+
+      @writer.end_tag('a:prstGeom')
+    end
+
+    #
+    # Write the <a:avLst> element.
+    #
+    def write_a_av_lst
+      @writer.empty_tag('a:avLst')
+    end
+  end
+end