write_xlsx 0.0.2

data/lib/write_xlsx/package/app.rb

@@ -0,0 +1,218 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class App
+
+      include Writexlsx::Utility
+
+      def initialize
+        @writer = Package::XMLWriterSimple.new
+        @part_names    = []
+        @heading_pairs = []
+        @properties    = {}
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration
+        write_properties
+        write_application
+        write_doc_security
+        write_scale_crop
+        write_heading_pairs
+        write_titles_of_parts
+        write_manager
+        write_company
+        write_links_up_to_date
+        write_shared_doc
+        write_hyperlinks_changed
+        write_app_version
+
+        @writer.end_tag('Properties')
+        @writer.crlf
+        @writer.close
+      end
+
+      def add_part_name(part_name)
+        @part_names.push(part_name)
+      end
+
+      def add_heading_pair(heading_pair)
+        return if heading_pair[1] == 0
+
+        @heading_pairs.push(['lpstr', heading_pair[0]], ['i4', heading_pair[1]])
+      end
+
+      #
+      # Set the document properties.
+      #
+      def set_properties(properties)
+        @properties = properties
+      end
+
+      private
+
+      def write_xml_declaration
+        @writer.xml_decl
+      end
+
+      #
+      # Write the <Properties> element.
+      #
+      def write_properties
+        schema   = 'http://schemas.openxmlformats.org/officeDocument/2006/'
+        xmlns    = "#{schema}extended-properties"
+        xmlns_vt = "#{schema}docPropsVTypes"
+
+        attributes = [
+            'xmlns',     xmlns,
+            'xmlns:vt',  xmlns_vt
+        ]
+
+        @writer.start_tag('Properties', attributes)
+      end
+
+      #
+      # Write the <Application> element.
+      #
+      def write_application
+        data = 'Microsoft Excel'
+
+        @writer.data_element('Application', data)
+      end
+
+      #
+      # Write the <DocSecurity> element.
+      #
+      def write_doc_security
+        data = 0
+
+        @writer.data_element('DocSecurity', data)
+      end
+
+      #
+      # Write the <ScaleCrop> element.
+      #
+      def write_scale_crop
+        data = 'false'
+
+        @writer.data_element('ScaleCrop', data)
+      end
+
+      #
+      # Write the <HeadingPairs> element.
+      #
+      def write_heading_pairs
+          @writer.start_tag('HeadingPairs')
+
+          write_vt_vector('variant', @heading_pairs)
+
+          @writer.end_tag('HeadingPairs')
+      end
+
+      #
+      # Write the <TitlesOfParts> element.
+      #
+      def write_titles_of_parts
+        @writer.start_tag('TitlesOfParts')
+        parts_data = []
+        @part_names.each { |part_name| parts_data.push(['lpstr', part_name]) }
+
+        write_vt_vector('lpstr', parts_data)
+
+        @writer.end_tag('TitlesOfParts')
+      end
+
+      #
+      # Write the <vt:vector> element.
+      #
+      def write_vt_vector(base_type, data)
+        size      = data.size
+
+        attributes = [
+          'size',     size,
+          'baseType', base_type
+        ]
+
+        @writer.start_tag('vt:vector', attributes)
+
+        data.each do |a|
+          @writer.start_tag('vt:variant') if base_type == 'variant'
+          write_vt_data(*a)
+          @writer.end_tag('vt:variant')   if base_type == 'variant'
+        end
+
+        @writer.end_tag('vt:vector')
+      end
+
+      #
+      # Write the <vt:*> elements such as <vt:lpstr> and <vt:if>.
+      #
+      def write_vt_data(type, data)
+        @writer.data_element("vt:#{type}", data)
+      end
+
+      #
+      # Write the <Company> element.
+      #
+      def write_company
+        data = @properties[:company] || ''
+
+        @writer.data_element('Company', data)
+      end
+
+      #
+      # Write the <Manager> element.
+      #
+      def write_manager
+        data = @properties[:manager]
+
+        return unless data
+
+        @writer.data_element('Manager', data)
+      end
+
+      #
+      # Write the <LinksUpToDate> element.
+      #
+      def write_links_up_to_date
+        data = 'false'
+
+        @writer.data_element('LinksUpToDate', data)
+      end
+
+      #
+      # Write the <SharedDoc> element.
+      #
+      def write_shared_doc
+        data = 'false'
+
+        @writer.data_element('SharedDoc', data)
+      end
+
+      #
+      # Write the <HyperlinksChanged> element.
+      #
+      def write_hyperlinks_changed
+        data = 'false'
+
+        @writer.data_element('HyperlinksChanged', data)
+      end
+
+      #
+      # Write the <AppVersion> element.
+      #
+      def write_app_version
+        data = '12.0000'
+
+        @writer.data_element('AppVersion', data)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/comments.rb

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class Comments
+
+      include Writexlsx::Utility
+
+      def initialize
+        @writer = Package::XMLWriterSimple.new
+        @author_ids = {}
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file(comments_data)
+        write_xml_declaration
+        write_comments
+        write_authors(comments_data)
+        write_comment_list(comments_data)
+
+        @writer.end_tag('comments')
+        @writer.crlf
+        @writer.close
+      end
+
+      private
+
+      def write_xml_declaration
+        @writer.xml_decl
+      end
+
+      #
+      # Write the <comments> element.
+      #
+      def write_comments
+        xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
+
+        attributes = [ 'xmlns', xmlns]
+
+        @writer.start_tag('comments', attributes)
+      end
+
+      #
+      # Write the <authors> element.
+      #
+      def write_authors(comment_data)
+        author_count = 0
+
+        @writer.start_tag('authors')
+        comment_data.each do |comment|
+          author = comment[3] || ''
+
+          if author && !@author_ids[author]
+            # Store the author id.
+            @author_ids[author] = author_count
+            author_count += 1
+
+            # Write the author element.
+            write_author(author)
+          end
+        end
+
+        @writer.end_tag('authors')
+      end
+
+      #
+      # Write the <author> element.
+      #
+      def write_author(data)
+        @writer.data_element('author', data)
+      end
+
+      #
+      # Write the <commentList> element.
+      #
+      def write_comment_list(comment_data)
+        @writer.start_tag('commentList')
+
+        comment_data.each do |comment|
+          row    = comment[0]
+          col    = comment[1]
+          text   = comment[2]
+          author = comment[3]
+
+          # Look up the author id.
+          author_id = nil
+          author_id = @author_ids[author] if author
+
+          # Write the comment element.
+          write_comment(row, col, text, author_id)
+        end
+
+        @writer.end_tag( 'commentList' )
+      end
+
+      #
+      # Write the <comment> element.
+      #
+      def write_comment(row, col, text, author_id)
+        ref       = xl_rowcol_to_cell( row, col )
+        author_id ||= 0
+
+        attributes = ['ref', ref]
+
+        (attributes << 'authorId' << author_id ) if author_id
+
+        @writer.start_tag('comment', attributes)
+        write_text(text)
+        @writer.end_tag('comment')
+      end
+
+      #
+      # Write the <text> element.
+      #
+      def write_text(text)
+        @writer.start_tag('text')
+
+        # Write the text r element.
+        write_text_r(text)
+
+        @writer.end_tag('text')
+      end
+
+      #
+      # Write the <r> element.
+      #
+      def write_text_r(text)
+        @writer.start_tag('r')
+
+        # Write the rPr element.
+        write_r_pr
+
+        # Write the text r element.
+        write_text_t(text)
+
+        @writer.end_tag('r')
+      end
+
+      #
+      # Write the text <t> element.
+      #
+      def write_text_t(text)
+        attributes = []
+
+        (attributes << 'xml:space' << 'preserve') if text =~ /^\s/ || text =~ /\s$/
+
+        @writer.data_element('t', text, attributes)
+      end
+
+      #
+      # Write the <rPr> element.
+      #
+      def write_r_pr
+        @writer.start_tag('rPr')
+
+        # Write the sz element.
+        write_sz
+
+        # Write the color element.
+        write_color
+
+        # Write the rFont element.
+        write_r_font
+
+        # Write the family element.
+        write_family
+
+        @writer.end_tag('rPr')
+      end
+
+      #
+      # Write the <sz> element.
+      #
+      def write_sz
+        val  = 8
+
+        attributes = ['val', val]
+
+        @writer.empty_tag('sz', attributes)
+      end
+
+      #
+      # Write the <color> element.
+      #
+      def write_color
+        indexed = 81
+
+        attributes = ['indexed', indexed]
+
+        @writer.empty_tag('color', attributes)
+      end
+
+      #
+      # Write the <rFont> element.
+      #
+      def write_r_font
+        val  = 'Tahoma'
+
+        attributes = ['val', val]
+
+        @writer.empty_tag('rFont', attributes)
+      end
+
+      #
+      # Write the <family> element.
+      #
+      def write_family
+        val  = 2
+
+        attributes = ['val', val]
+
+        @writer.empty_tag('family', attributes)
+      end
+    end
+  end
+end

data/lib/write_xlsx/package/content_types.rb

@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  module Package
+    class ContentTypes
+
+      include Writexlsx::Utility
+
+      App_package  = 'application/vnd.openxmlformats-package.'
+      App_document = 'application/vnd.openxmlformats-officedocument.'
+
+      def initialize
+        @writer = Package::XMLWriterSimple.new
+        @defaults  = [
+          [ 'rels', "#{App_package}relationships+xml" ],
+          [ 'xml', 'application/xml' ]
+        ]
+        @overrides = [
+          [ '/docProps/app.xml',    "#{App_document}extended-properties+xml" ],
+          [ '/docProps/core.xml',   "#{App_package}core-properties+xml" ],
+          [ '/xl/styles.xml',       "#{App_document}spreadsheetml.styles+xml" ],
+          [ '/xl/theme/theme1.xml', "#{App_document}theme+xml" ],
+          [ '/xl/workbook.xml',     "#{App_document}spreadsheetml.sheet.main+xml" ]
+        ]
+      end
+
+      def set_xml_writer(filename)
+        @writer.set_xml_writer(filename)
+      end
+
+      def assemble_xml_file
+        write_xml_declaration
+        write_types
+        write_defaults
+        write_overrides
+
+        @writer.end_tag('Types')
+        @writer.crlf
+        @writer.close
+      end
+      #
+      # Add elements to the ContentTypes defaults.
+      #
+      def add_default(part_name, content_type)
+        @defaults.push([part_name, content_type])
+      end
+
+      #
+      # Add elements to the ContentTypes overrides.
+      #
+      def add_override(part_name, content_type)
+        @overrides.push([part_name, content_type])
+      end
+
+      #
+      # Add the name of a worksheet to the ContentTypes overrides.
+      #
+      def add_worksheet_name(name)
+        worksheet_name = "/xl/worksheets/#{name}.xml"
+
+        add_override(worksheet_name, "#{App_document}spreadsheetml.worksheet+xml")
+      end
+
+      #
+      # Add the name of a chartsheet to the ContentTypes overrides.
+      #
+      def add_chartsheet_name(name)
+        chartsheet_name = "/xl/chartsheets/#{name}.xml"
+
+        add_override(chartsheet_name, "#{App_document}spreadsheetml.chartsheet+xml")
+      end
+
+      #
+      # Add the name of a chart to the ContentTypes overrides.
+      #
+      def add_chart_name(name)
+        chart_name = "/xl/charts/#{name}.xml"
+
+        add_override(chart_name, "#{App_document}drawingml.chart+xml")
+      end
+
+      #
+      # Add the name of a drawing to the ContentTypes overrides.
+      #
+      def add_drawing_name(name)
+        drawing_name = "/xl/drawings/#{name}.xml"
+
+        add_override( drawing_name, "#{App_document}drawing+xml")
+      end
+
+      #
+      # Add the name of a VML drawing to the ContentTypes defaults.
+      #
+      def add_vml_name
+        add_default('vml', "#{App_document}vmlDrawing")
+      end
+
+      #
+      # Add the name of a comment to the ContentTypes overrides.
+      #
+      def add_comment_name(name)
+        comment_name = "/xl/#{name}.xml"
+
+        add_override( comment_name, "#{App_document}spreadsheetml.comments+xml")
+      end
+
+      #
+      # Add the sharedStrings link to the ContentTypes overrides.
+      #
+      def add_shared_strings
+        add_override('/xl/sharedStrings.xml', "#{App_document}spreadsheetml.sharedStrings+xml")
+      end
+
+      #
+      # Add the calcChain link to the ContentTypes overrides.
+      #
+      def add_calc_chain
+        add_override('/xl/calcChain.xml', "#{App_document}spreadsheetml.calcChain+xml")
+      end
+
+      #
+      # Add the image default types.
+      #
+      def add_image_types(types)
+        types.each_key { |type| add_default(type, "image/#{type}") }
+      end
+
+      private
+
+      def write_xml_declaration
+        @writer.xml_decl
+      end
+
+      #
+      # Write out all of the <Default> types.
+      #
+      def write_defaults
+        @defaults.each do |a|
+          @writer.empty_tag('Default', ['Extension', a[0], 'ContentType', a[1]])
+        end
+      end
+
+      #
+      # Write out all of the <Override> types.
+      #
+      def write_overrides
+        @overrides.each do |a|
+          @writer.empty_tag('Override', ['PartName', a[0], 'ContentType', a[1]])
+        end
+      end
+
+      #
+      # Write the <Types> element.
+      #
+      def write_types
+        xmlns = 'http://schemas.openxmlformats.org/package/2006/content-types'
+        attributes = ['xmlns', xmlns]
+
+        @writer.start_tag('Types', attributes)
+      end
+
+      #
+      # Write the <Default> element.
+      #
+      def write_default(extension, content_type)
+        attributes = [
+          'Extension',   extension,
+          'ContentType', content_type
+        ]
+
+        @writer.empty_tag('Default', attributes)
+      end
+
+      #
+      # Write the <Override> element.
+      #
+      def write_override(part_name, content_type)
+        attributes = [
+          'PartName',    part_name,
+          'ContentType', content_type
+        ]
+
+        @writer.empty_tag('Override', attributes)
+      end
+    end
+  end
+end