write_xlsx 0.64.1 → 0.65.0

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -12,9 +12,7 @@ module Writexlsx
       end
 
       def set_xml_writer(filename = nil)
-        fh = File.open(filename, "wb")
-
-        @io = fh
+        @filename = filename
       end
 
       def xml_decl(encoding = 'UTF-8', standalone = true)
@@ -28,14 +26,27 @@ module Writexlsx
         end_tag(tag)
       end
 
+      def tag_elements_str(tag, attributes = [])
+        str = ''
+        str << start_tag_str(tag, attributes)
+        str << yield
+        str << end_tag_str(tag)
+      end
+
       def start_tag(tag, attr = [])
-        str = "<#{tag}#{key_vals(attr)}>"
-        io_write(str)
+        io_write(start_tag_str(tag, attr))
+      end
+
+      def start_tag_str(tag, attr = [])
+        "<#{tag}#{key_vals(attr)}>"
       end
 
       def end_tag(tag)
-        str = "</#{tag}>"
-        io_write(str)
+        io_write(end_tag_str(tag))
+      end
+
+      def end_tag_str(tag)
+        "</#{tag}>"
       end
 
       def empty_tag(tag, attr = [])
@@ -44,8 +55,11 @@ module Writexlsx
       end
 
       def empty_tag_encoded(tag, attr = [])
-        str = "<#{tag}#{key_vals(attr)}/>"
-        io_write(str)
+        io_write(empty_tag_encoded_str(tag, attr))
+      end
+
+      def empty_tag_encoded_str(tag, attr = [])
+        "<#{tag}#{key_vals(attr)}/>"
       end
 
       def data_element(tag, data, attr = [])
@@ -75,6 +89,9 @@ module Writexlsx
       end
 
       def close
+        if @filename
+          File.open(@filename, "wb") { |f| f << string }
+        end
         @io.close
       end
 

data/lib/write_xlsx/sheets.rb

@@ -0,0 +1,223 @@
+# -*- encoding: utf-8 -*-
+require 'delegate'
+require 'write_xlsx/package/xml_writer_simple'
+
+module Writexlsx
+  class Sheets < DelegateClass(Array)
+    include Writexlsx::Utility
+
+    BASE_NAME = { :sheet => 'Sheet', :chart => 'Chart'}  # :nodoc:
+
+    def initialize
+      super([])
+    end
+
+    def chartsheet_count
+      chartsheets.count
+    end
+
+    def sheetname_count
+      self.count - chartname_count
+    end
+
+    def chartname_count
+      chartsheet_count
+    end
+
+    def make_and_check_sheet_chart_name(type, name)
+      count = sheet_chart_count(type)
+      name = "#{BASE_NAME[type]}#{count+1}" unless ptrue?(name)
+
+      check_valid_sheetname(name)
+      name
+    end
+
+    def write_sheets(writer)
+      writer.tag_elements('sheets') do
+        id_num = 1
+        self.each do |sheet|
+          write_sheet(writer, sheet, id_num)
+          id_num += 1
+        end
+      end
+    end
+
+    def write_worksheet_files(package_dir)
+      dir = "#{package_dir}/xl/worksheets"
+      worksheets.each_with_index do |sheet, index|
+        write_sheet_files(dir, sheet, index)
+      end
+    end
+
+    def write_chartsheet_files(package_dir)
+      dir = "#{package_dir}/xl/chartsheets"
+      chartsheets.each_with_index do |sheet, index|
+        write_sheet_files(dir, sheet, index)
+      end
+    end
+
+    def write_vml_files(package_dir)
+      dir = "#{package_dir}/xl/drawings"
+      self.select { |sheet| sheet.has_vml? }.
+        each_with_index do |sheet, index|
+        FileUtils.mkdir_p(dir)
+
+        vml = Package::Vml.new
+        vml.set_xml_writer("#{dir}/vmlDrawing#{index+1}.vml")
+        vml.assemble_xml_file(sheet)
+      end
+    end
+
+    def write_comment_files(package_dir)
+      self.select { |sheet| sheet.has_comments? }.
+        each_with_index do |sheet, index|
+        FileUtils.mkdir_p("#{package_dir}/xl/drawings")
+        sheet.comments.set_xml_writer("#{package_dir}/xl/comments#{index+1}.xml")
+        sheet.comments.assemble_xml_file
+      end
+    end
+
+    def write_table_files(package_dir)
+      unless tables.empty?
+        dir = "#{package_dir}/xl/tables"
+        FileUtils.mkdir_p(dir)
+        tables.each_with_index do |table, index|
+          table.set_xml_writer("#{dir}/table#{index+1}.xml")
+          table.assemble_xml_file
+        end
+      end
+    end
+
+    def write_chartsheet_rels_files(package_dir)
+      write_sheet_rels_files_base(chartsheets, "#{package_dir}/xl/chartsheets/_rels",
+                            'sheet')
+    end
+
+    def write_drawing_rels_files(package_dir)
+      # write_rels_files_base(
+      #                       self.reject { |sheet| sheet.drawing_links[0].empty? },
+      #                       "#{package_dir}/xl/drawings/_rels",
+
+      #                       )
+      dir = "#{package_dir}/xl/drawings/_rels"
+      self.reject { |sheet| sheet.drawing_links[0].empty? }.
+        each_with_index do |sheet, index|
+
+        FileUtils.mkdir_p(dir)
+
+        rels = Package::Relationships.new
+
+        sheet.drawing_links.each do |drawing_datas|
+          drawing_datas.each do |drawing_data|
+            rels.add_document_relationship(*drawing_data)
+          end
+        end
+
+        # Create the .rels file such as /xl/drawings/_rels/sheet1.xml.rels.
+        rels.set_xml_writer("#{dir}/drawing#{index+1}.xml.rels")
+        rels.assemble_xml_file
+      end
+    end
+
+    def write_worksheet_rels_files(package_dir)
+      write_sheet_rels_files_base(worksheets, "#{package_dir}/xl/worksheets/_rels",
+                            'sheet')
+    end
+
+    def write_sheet_rels_files_base(sheets, dir, body)
+      sheets.each_with_index do |sheet, index|
+
+        next if sheet.external_links.empty?
+
+        FileUtils.mkdir_p(dir)
+
+        rels = Package::Relationships.new
+
+        sheet.external_links.each do |link_datas|
+          link_datas.each do |link_data|
+            rels.add_worksheet_relationship(*link_data)
+          end
+        end
+
+        # Create the .rels file such as /xl/worksheets/_rels/sheet1.xml.rels.
+        rels.set_xml_writer("#{dir}/#{body}#{index+1}.xml.rels")
+        rels.assemble_xml_file
+      end
+    end
+
+    def tables
+      self.inject([]) { |tables, sheet| tables + sheet.tables }.flatten
+    end
+
+    def tables_count
+      tables.count
+    end
+
+    def index_by_name(sheetname)
+      name = sheetname.sub(/^'/,'').sub(/'$/,'')
+      self.collect { |sheet| sheet.name }.index(name)
+    end
+
+    private
+
+    def worksheets
+      self.reject { |worksheet| worksheet.is_chartsheet? }
+    end
+
+    def chartsheets
+      self.select { |worksheet| worksheet.is_chartsheet? }
+    end
+
+    def sheet_chart_count(type)
+      case type
+      when :sheet
+        sheetname_count
+      when :chart
+        chartname_count
+      end
+    end
+
+    def check_valid_sheetname(name)
+      # Check that sheet name is <= 31. Excel limit.
+      raise "Sheetname #{name} must be <= #{SHEETNAME_MAX} chars" if name.length > SHEETNAME_MAX
+
+      # Check that sheetname doesn't contain any invalid characters
+      invalid_char = /[\[\]:*?\/\\]/
+      if name =~ invalid_char
+        raise 'Invalid character []:*?/\\ in worksheet name: ' + name
+      end
+
+      # Check that the worksheet name doesn't already exist since this is a fatal
+      # error in Excel 97. The check must also exclude case insensitive matches.
+      unless is_sheetname_uniq?(name)
+        raise "Worksheet name '#{name}', with case ignored, is already used."
+      end
+    end
+
+    def is_sheetname_uniq?(name)
+      self.each do |worksheet|
+        return false if name.downcase == worksheet.name.downcase
+      end
+      true
+    end
+
+    def write_sheet_files(dir, sheet, index)
+      FileUtils.mkdir_p(dir)
+      sheet.set_xml_writer("#{dir}/sheet#{index+1}.xml")
+      sheet.assemble_xml_file
+    end
+
+    def write_sheet(writer, sheet, sheet_id) #:nodoc:
+      attributes = [
+        'name',    sheet.name,
+        'sheetId', sheet_id
+      ]
+
+      if sheet.hidden?
+        attributes << 'state' << 'hidden'
+      end
+      attributes << 'r:id' << "rId#{sheet_id}"
+      writer.empty_tag_encoded('sheet', attributes)
+    end
+  end
+end

data/lib/write_xlsx/sparkline.rb

@@ -14,10 +14,6 @@ module Writexlsx
   class Sparkline
     include Writexlsx::Utility
 
-    attr_accessor :locations, :ranges
-    attr_accessor :date_axis, :series_color, :negative_color, :markers_color
-    attr_accessor :first_color, :last_color, :high_color, :low_color
-
     def initialize(ws, param, sheetname)
       @color = {}
 
@@ -141,8 +137,148 @@ module Writexlsx
       a
     end
 
+    #
+    # Write the <x14:sparklineGroup> element.
+    #
+    # Example for order.
+    #
+    # <x14:sparklineGroup
+    #     manualMax="0"
+    #     manualMin="0"
+    #     lineWeight="2.25"
+    #     type="column"
+    #     dateAxis="1"
+    #     displayEmptyCellsAs="span"
+    #     markers="1"
+    #     high="1"
+    #     low="1"
+    #     first="1"
+    #     last="1"
+    #     negative="1"
+    #     displayXAxis="1"
+    #     displayHidden="1"
+    #     minAxisType="custom"
+    #     maxAxisType="custom"
+    #     rightToLeft="1">
+    #
+    def write_sparkline_group(writer)
+      @writer = writer
+
+      @writer.tag_elements('x14:sparklineGroup', group_attributes) do
+        write
+      end
+    end
+
     private
 
+    def write
+      write_color_series
+      write_color_negative
+      write_color_axis
+      write_color_markers
+      write_color_first
+      write_color_last
+      write_color_high
+      write_color_low
+      write_xmf_date_axis if @date_axis
+      write_sparklines
+    end
+
+    #
+    # Write the <x14:colorSeries> element.
+    #
+    def write_color_series
+      write_spark_color('x14:colorSeries', @series_color)
+    end
+
+    #
+    # Write the <x14:colorNegative> element.
+    #
+    def write_color_negative
+      write_spark_color('x14:colorNegative', @negative_color)
+    end
+
+    #
+    # Write the <x14:colorAxis> element.
+    #
+    def write_color_axis  # :nodoc:
+      write_spark_color('x14:colorAxis', { :_rgb => 'FF000000'} )
+    end
+
+    #
+    # Write the <x14:colorMarkers> element.
+    #
+    def write_color_markers  # :nodoc:
+      write_spark_color('x14:colorMarkers', @markers_color)
+    end
+
+    #
+    # Write the <x14:colorFirst> element.
+    #
+    def write_color_first  # :nodoc:
+      write_spark_color('x14:colorFirst', @first_color)
+    end
+
+    #
+    # Write the <x14:colorLast> element.
+    #
+    def write_color_last  # :nodoc:
+      write_spark_color('x14:colorLast', @last_color)
+    end
+
+    #
+    # Write the <x14:colorHigh> element.
+    #
+    def write_color_high  # :nodoc:
+      write_spark_color('x14:colorHigh', @high_color)
+    end
+
+    #
+    # Write the <x14:colorLow> element.
+    #
+    def write_color_low  # :nodoc:
+      write_spark_color('x14:colorLow', @low_color)
+    end
+
+    #
+    # Write the <xm:f> element.
+    #
+    def write_xmf_date_axis
+      @writer.data_element('xm:f', @date_axis)
+    end
+
+    #
+    # Write the <x14:sparklines> element and <x14:sparkline> subelements.
+    #
+    def write_sparklines  # :nodoc:
+      # Write the sparkline elements.
+      @writer.tag_elements('x14:sparklines') do
+
+        (0 .. count-1).each do |i|
+          range    = @ranges[i]
+          location = @locations[i]
+
+          @writer.tag_elements('x14:sparkline') do
+            @writer.data_element('xm:f',     range)
+            @writer.data_element('xm:sqref', location)
+          end
+        end
+      end
+    end
+
+    #
+    # Helper function for the sparkline color functions below.
+    #
+    def write_spark_color(element, color)  # :nodoc:
+      attr = []
+
+      attr << 'rgb'   << color[:_rgb]   if color[:_rgb]
+      attr << 'theme' << color[:_theme] if color[:_theme]
+      attr << 'tint'  << color[:_tint]  if color[:_tint]
+
+      @writer.empty_tag(element, attr)
+    end
+
     def set_spark_color(user_color, palette_color)
       return unless palette_color
 

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.64.1"
+  VERSION = "0.65.0"
 end