write_xlsx 1.12.0 → 1.12.2

data/lib/write_xlsx/workbook.rb

@@ -1,30 +1,33 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
-require 'write_xlsx/package/xml_writer_simple'
-require 'write_xlsx/package/packager'
-require 'write_xlsx/sheets'
-require 'write_xlsx/worksheet'
+require 'write_xlsx/chart'
 require 'write_xlsx/chartsheet'
-require 'write_xlsx/formats'
 require 'write_xlsx/format'
+require 'write_xlsx/formats'
+require 'write_xlsx/image_property'
 require 'write_xlsx/shape'
+require 'write_xlsx/sheets'
 require 'write_xlsx/utility'
-require 'write_xlsx/chart'
+require 'write_xlsx/worksheet'
 require 'write_xlsx/zip_file_utils'
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/package/packager'
 require 'tmpdir'
 require 'tempfile'
 require 'digest/md5'
 
 module Writexlsx
-  OFFICE_URL = 'http://schemas.microsoft.com/office/'   # :nodoc:
+  OFFICE_URL     = 'http://schemas.microsoft.com/office/'   # :nodoc:
+  MAX_URL_LENGTH = 2_079
 
   class Workbook
     include Writexlsx::Utility
 
     attr_writer :firstsheet                     # :nodoc:
     attr_reader :palette                        # :nodoc:
-    attr_reader :worksheets, :charts, :drawings # :nodoc:
+    attr_reader :worksheets                     # :nodoc:
+    attr_accessor :drawings                     # :nodoc:
     attr_reader :named_ranges                   # :nodoc:
     attr_reader :doc_properties                 # :nodoc:
     attr_reader :custom_properties              # :nodoc:
@@ -38,9 +41,13 @@ module Writexlsx
     attr_reader :embedded_image_indexes         # :nodec:
     attr_reader :embedded_images                # :nodoc:
     attr_reader :embedded_descriptions          # :nodoc:
+    attr_writer :has_embedded_descriptions      # :nodoc:
+    attr_accessor :charts                       # :nodoc:
 
     def initialize(file, *option_params)
       options, default_formats = process_workbook_options(*option_params)
+      @options = options.dup                    # for test
+      @default_formats = default_formats.dup    # for test
       @writer = Package::XMLWriterSimple.new
 
       @file = file
@@ -60,7 +67,6 @@ module Writexlsx
       @formats             = Formats.new
       @xf_formats          = []
       @dxf_formats         = []
-      @font_count          = 0
       @num_formats         = []
       @defined_names       = []
       @named_ranges        = []
@@ -70,16 +76,15 @@ module Writexlsx
       @optimization        = options[:optimization] || 0
       @x_window            = 240
       @y_window            = 15
-      @window_width        = 16095
-      @window_height       = 9660
+      @window_width        = 16_095
+      @window_height       = 9_660
       @tab_ratio           = 600
       @excel2003_style     = options[:excel2003_style] || false
-      @table_count         = 0
       @image_types         = {}
       @images              = []
       @strings_to_urls     = options[:strings_to_urls].nil? || options[:strings_to_urls] ? true : false
 
-      @max_url_length      = 2079
+      @max_url_length      = MAX_URL_LENGTH
       @has_comments        = false
       @read_only           = 0
       @has_metadata        = false
@@ -87,10 +92,11 @@ module Writexlsx
       @has_embedded_descriptions = false
 
       if options[:max_url_length]
-        @max_url_length = options[:max_url_length]
+        @max_url_length = options[:max_url_length].to_i
 
-        @max_url_length = 2079 if @max_url_length < 250
+        @max_url_length = MAX_URL_LENGTH if @max_url_length < 255
       end
+
       # Structures for the shared strings data.
       @shared_strings = Package::SharedStrings.new
 
@@ -619,8 +625,51 @@ module Writexlsx
       @has_embedded_descriptions
     end
 
+    #
+    # Store the image types (PNG/JPEG/etc) used in the workbook to use in these
+    # Content_Types file.
+    #
+    def store_image_types(type)
+      case type
+      when 'png'
+        @image_types[:png] = 1
+      when 'jpeg'
+        @image_types[:jpeg] = 1
+      when 'gif'
+        @image_types[:gif] = 1
+      when 'bmp'
+        @image_types[:bmp] = 1
+      end
+    end
+
     private
 
+    #
+    # Workbook の生成時のオプションハッシュを解析する
+    #
+    def process_workbook_options(*params)
+      case params.size
+      when 0
+        [{}, {}]
+      when 1 # one hash
+        options_keys = %i[tempdir date_1904 optimization excel2003_style strings_to_urls max_url_length]
+
+        hash = params.first
+        options = hash.reject { |k, _v| !options_keys.include?(k) }
+
+        default_format_properties =
+          hash[:default_format_properties] ||
+          hash.reject { |k, _v| options_keys.include?(k) }
+
+        [options, default_format_properties.dup]
+      when 2 # array which includes options and default_format_properties
+        options, default_format_properties = params
+        default_format_properties ||= {}
+
+        [options.dup, default_format_properties.dup]
+      end
+    end
+
     def filename
       setup_filename unless @filename
       @filename
@@ -732,7 +781,7 @@ module Writexlsx
 
       if pos > 0
         sheetname = range[0, pos]
-        cells = range[pos + 1..-1]
+        cells = range[(pos + 1)..-1]
       end
 
       # Split the cell range into 2 cells or else use single cell for both.
@@ -924,24 +973,10 @@ module Writexlsx
       Writexlsx::Utility.delete_files(tempdir)
     end
 
-    def write_parts(zip)
-      parts.each do |part|
-        zip.put_next_entry(zip_entry_for_part(part.sub(Regexp.new("#{tempdir}/?"), '')))
-        zip.puts(File.read(part))
-      end
-    end
-
     def zip_entry_for_part(part)
       Zip::Entry.new("", part)
     end
 
-    #
-    # files
-    #
-    def parts
-      Dir.glob(File.join(tempdir, "**", "*"), File::FNM_DOTMATCH).select { |f| File.file?(f) }
-    end
-
     #
     # prepare_sst_string_data
     #
@@ -1188,7 +1223,6 @@ module Writexlsx
       vml_data_id    = 1
       vml_header_id  = 0
       vml_shape_id   = 1024
-      comment_files  = 0
       has_button     = false
 
       @worksheets.each do |sheet|
@@ -1196,8 +1230,7 @@ module Writexlsx
 
         if sheet.has_vml?
           if sheet.has_comments?
-            comment_files += 1
-            comment_id    += 1
+            comment_id += 1
             @has_comments = true
           end
           vml_drawing_id += 1
@@ -1402,158 +1435,37 @@ module Writexlsx
     # Iterate through the worksheets and set up any chart or image drawings.
     #
     def prepare_drawings # :nodoc:
-      chart_ref_id     = 0
-      drawing_id       = 0
-      ref_id           = 0
-      image_ids        = {}
-      header_image_ids = {}
-      background_ids   = {}
-
       # Store the image types for any embedded images.
-      @embedded_images.each do |image_data|
-        store_image_types(image_data[1])
+      @embedded_images.each do |image|
+        store_image_types(image.type)
 
-        @has_embedded_descriptions = true if ptrue?(image_data[2])
+        @has_embedded_descriptions = true if ptrue?(image.description)
       end
 
-      # The image IDs start from after the embedded images.
-      image_ref_id = @embedded_images.size
-
-      @worksheets.each do |sheet|
-        chart_count = sheet.charts.size
-        image_count = sheet.images.size
-        shape_count = sheet.shapes.size
-        header_image_count = sheet.header_images.size
-        footer_image_count = sheet.footer_images.size
-        has_background     = sheet.background_image.size
-        has_drawings       = false
-
-        # Check that some image or drawing needs to be processed.
-        next if chart_count + image_count + shape_count + header_image_count + footer_image_count + has_background == 0
-
-        # Don't increase the drawing_id header/footer images.
-        if chart_count + image_count + shape_count > 0
-          drawing_id += 1
-          has_drawings = true
-        end
-
-        # Prepare the background images.
-        if ptrue?(has_background)
-          filename = sheet.background_image
-          type, width, height, name, x_dpi, y_dpi, md5 = get_image_properties(filename)
-
-          if background_ids[md5]
-            ref_id = background_ids[md5]
-          else
-            image_ref_id += 1
-            ref_id = image_ref_id
-            background_ids[md5] = ref_id
-            @images << [filename, type]
-          end
-
-          sheet.prepare_background(ref_id, type)
-        end
-
-        # Prepare the worksheet images.
-        sheet.images.each_with_index do |image, index|
-          filename = image[2]
-          type, width, height, name, x_dpi, y_dpi, md5 = get_image_properties(image[2])
-          if image_ids[md5]
-            ref_id = image_ids[md5]
-          else
-            image_ref_id += 1
-            image_ids[md5] = ref_id = image_ref_id
-            @images << [filename, type]
-          end
-          sheet.prepare_image(
-            index, ref_id, drawing_id, width, height,
-            name,  type,   x_dpi,      y_dpi, md5
-          )
-        end
-
-        # Prepare the worksheet charts.
-        sheet.charts.each_with_index do |_chart, index|
-          chart_ref_id += 1
-          sheet.prepare_chart(index, chart_ref_id, drawing_id)
-        end
-
-        # Prepare the worksheet shapes.
-        sheet.shapes.each_with_index do |_shape, index|
-          sheet.prepare_shape(index, drawing_id)
-        end
-
-        # Prepare the header images.
-        header_image_count.times do |index|
-          filename = sheet.header_images[index][0]
-          position = sheet.header_images[index][1]
-
-          type, width, height, name, x_dpi, y_dpi, md5 =
-            get_image_properties(filename)
-
-          if header_image_ids[md5]
-            ref_id = header_image_ids[md5]
-          else
-            image_ref_id += 1
-            header_image_ids[md5] = ref_id = image_ref_id
-            @images << [filename, type]
-          end
-
-          sheet.prepare_header_image(
-            ref_id,   width, height, name, type,
-            position, x_dpi, y_dpi,  md5
-          )
-        end
-
-        # Prepare the footer images.
-        footer_image_count.times do |index|
-          filename = sheet.footer_images[index][0]
-          position = sheet.footer_images[index][1]
-
-          type, width, height, name, x_dpi, y_dpi, md5 =
-            get_image_properties(filename)
-
-          if header_image_ids[md5]
-            ref_id = header_image_ids[md5]
-          else
-            image_ref_id += 1
-            header_image_ids[md5] = ref_id = image_ref_id
-            @images << [filename, type]
-          end
-
-          sheet.prepare_header_image(
-            ref_id,   width, height, name, type,
-            position, x_dpi, y_dpi,  md5
-          )
-        end
-
-        if has_drawings
-          drawings = sheet.drawings
-          @drawings << drawings
-        end
-      end
+      prepare_drawings_of_all_sheets
 
       # Sort the workbook charts references into the order that the were
       # written from the worksheets above.
       @charts = @charts.select { |chart| chart.id != -1 }
-                       .sort_by { |chart| chart.id }
-
-      @drawing_count = drawing_id
+                  .sort_by { |chart| chart.id }
     end
 
-    #
-    # Store the image types (PNG/JPEG/etc) used in the workbook to use in these
-    # Content_Types file.
-    #
-    def store_image_types(type)
-      case type
-      when 'png'
-        @image_types[:png] = 1
-      when 'jpeg'
-        @image_types[:jpeg] = 1
-      when 'gif'
-        @image_types[:gif] = 1
-      when 'bmp'
-        @image_types[:bmp] = 1
+    def prepare_drawings_of_all_sheets
+      drawing_id       = 0
+      chart_ref_id     = 0
+      image_ids        = {}
+      header_image_ids = {}
+      background_ids   = {}
+
+      # The image IDs start from after the embedded images.
+      image_ref_id = @embedded_images.size
+
+      @worksheets.each do |sheet|
+        drawing_id, chart_ref_id, image_ref_id =
+          sheet.prepare_drawings(
+            drawing_id, chart_ref_id, image_ref_id, image_ids,
+            header_image_ids, background_ids
+          )
       end
     end
   end

data/lib/write_xlsx/worksheet/data_validation.rb

@@ -163,7 +163,7 @@ module Writexlsx
           attributes << %w[errorStyle information] if @error_type == 2
         end
         attributes << ['allowBlank',       1] if @ignore_blank != 0
-        attributes << ['showDropDown',     1] if @dropdown     == 0
+        attributes << ['showDropDown',     1] if @dropdown == 0
         attributes << ['showInputMessage', 1] if @show_input   != 0
         attributes << ['showErrorMessage', 1] if @show_error   != 0
 

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -34,7 +34,7 @@ module Writexlsx
         url = escape_url(url)
 
         # Excel limits the escaped URL and location/anchor to 255 characters.
-        raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
+        raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the WriteXLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
 
         @url       = url
         @str       = normalized_str
@@ -123,7 +123,7 @@ module Writexlsx
         @url_str   = url_str
 
         # Excel limits the escaped URL and location/anchor to max_url_length characters.
-        raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the Excel::Writer::XLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
+        raise "Ignoring URL '#{url}' where link or anchor > #{max_url_length} characters since it exceeds Excel's limit for URLS. See LIMITATIONS section of the WriteXLSX documentation." if url.bytesize > max_url_length || (!@url_str.nil? && @url_str.bytesize > max_url_length)
 
         @url       = url
         @str       = str