write_xlsx 1.09.3 → 1.11.2

data/lib/write_xlsx/package/content_types.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 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.'
@@ -15,15 +16,15 @@ module Writexlsx
         @writer = Package::XMLWriterSimple.new
         @workbook  = workbook
         @defaults  = [
-          [ 'rels', "#{App_package}relationships+xml" ],
-          [ 'xml', 'application/xml' ]
+          ['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" ]
+          ['/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
 
@@ -39,6 +40,7 @@ module Writexlsx
           end
         end
       end
+
       #
       # Add elements to the ContentTypes defaults.
       #
@@ -55,7 +57,7 @@ module Writexlsx
 
       def add_worksheet_names
         @workbook.non_chartsheet_count.times do |index|
-          add_worksheet_name("sheet#{index+1}")
+          add_worksheet_name("sheet#{index + 1}")
         end
       end
 
@@ -70,7 +72,7 @@ module Writexlsx
 
       def add_chartsheet_names
         @workbook.chartsheet_count.times do |index|
-          add_chartsheet_name("sheet#{index+1}")
+          add_chartsheet_name("sheet#{index + 1}")
         end
       end
 
@@ -84,7 +86,7 @@ module Writexlsx
       end
 
       def add_chart_names
-        (1 .. @workbook.charts.size).each { |i| add_chart_name("chart#{i}") }
+        (1..@workbook.charts.size).each { |i| add_chart_name("chart#{i}") }
       end
 
       #
@@ -97,7 +99,7 @@ module Writexlsx
       end
 
       def add_drawing_names
-        (1 .. @workbook.drawings.size).each do |i|
+        (1..@workbook.drawings.size).each do |i|
           add_drawing_name("drawing#{i}")
         end
       end
@@ -108,7 +110,7 @@ module Writexlsx
       def add_drawing_name(name)
         drawing_name = "/xl/drawings/#{name}.xml"
 
-        add_override( drawing_name, "#{App_document}drawing+xml")
+        add_override(drawing_name, "#{App_document}drawing+xml")
       end
 
       #
@@ -119,7 +121,7 @@ module Writexlsx
       end
 
       def add_comment_names
-        (1 .. @workbook.num_comment_files).each do |i|
+        (1..@workbook.num_comment_files).each do |i|
           add_comment_name("comments#{i}")
         end
       end
@@ -130,7 +132,7 @@ module Writexlsx
       def add_comment_name(name)
         comment_name = "/xl/#{name}.xml"
 
-        add_override( comment_name, "#{App_document}spreadsheetml.comments+xml")
+        add_override(comment_name, "#{App_document}spreadsheetml.comments+xml")
       end
 
       #
@@ -157,7 +159,7 @@ module Writexlsx
       end
 
       def add_table_names(table_count)
-        (1 .. table_count).each { |i| add_table_name("table#{i}") }
+        (1..table_count).each { |i| add_table_name("table#{i}") }
       end
 
       #
@@ -201,9 +203,7 @@ module Writexlsx
 
       def change_the_workbook_xml_content_type_from_xlsx_to_xlsm
         @overrides.collect! do |arr|
-          if arr[0] == '/xl/workbook.xml'
-            arr[1] = 'application/vnd.ms-excel.sheet.macroEnabled.main+xml'
-          end
+          arr[1] = 'application/vnd.ms-excel.sheet.macroEnabled.main+xml' if arr[0] == '/xl/workbook.xml'
           arr
         end
       end
@@ -237,13 +237,13 @@ module Writexlsx
       #
       # Write the <Types> element.
       #
-      def write_types
+      def write_types(&block)
         xmlns = 'http://schemas.openxmlformats.org/package/2006/content-types'
         attributes = [
           ['xmlns', xmlns]
         ]
 
-        @writer.tag_elements('Types', attributes) { yield }
+        @writer.tag_elements('Types', attributes, &block)
       end
 
       #

data/lib/write_xlsx/package/core.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
     class Core
-
       include Writexlsx::Utility
 
       App_package  = 'application/vnd.openxmlformats-package.'
@@ -60,7 +61,7 @@ module Writexlsx
       #
       # Write the <cp:coreProperties> element.
       #
-      def write_cp_core_properties
+      def write_cp_core_properties(&block)
         xmlns_cp       = 'http://schemas.openxmlformats.org/package/2006/metadata/core-properties'
         xmlns_dc       = 'http://purl.org/dc/elements/1.1/'
         xmlns_dcterms  = 'http://purl.org/dc/terms/'
@@ -75,7 +76,7 @@ module Writexlsx
           ['xmlns:xsi',      xmlns_xsi]
         ]
 
-        @writer.tag_elements('cp:coreProperties', attributes) { yield }
+        @writer.tag_elements('cp:coreProperties', attributes, &block)
       end
 
       #
@@ -107,7 +108,7 @@ module Writexlsx
       end
 
       def write_dcterms(tag)
-        @writer.data_element(tag, dcterms_date, [ ['xsi:type', 'dcterms:W3CDTF'] ])
+        @writer.data_element(tag, dcterms_date, [['xsi:type', 'dcterms:W3CDTF']])
       end
 
       def dcterms_date
@@ -159,6 +160,7 @@ module Writexlsx
       def write_base(key, tag, default = nil)
         data = @properties[key] || default
         return unless data
+
         @writer.data_element(tag, data)
       end
     end

data/lib/write_xlsx/package/custom.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
     class Custom
-
       include Writexlsx::Utility
 
       def initialize
@@ -43,7 +44,7 @@ module Writexlsx
           ['xmlns:vt', xmlns_vt]
         ]
 
-        @writer.tag_elements('Properties', attributes ) do
+        @writer.tag_elements('Properties', attributes) do
           @properties.each do |property|
             # Write the property element.
             write_property(property)
@@ -105,11 +106,11 @@ module Writexlsx
       # Write the <vt:bool> element.
       #
       def write_vt_bool(data)
-        if ptrue?(data)
-          data = 'true'
-        else
-          data = 'false'
-        end
+        data = if ptrue?(data)
+                 'true'
+               else
+                 'false'
+               end
 
         @writer.data_element('vt:bool', data)
       end

data/lib/write_xlsx/package/metadata.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
@@ -55,7 +57,7 @@ module Writexlsx
       # Write the <metadataTypes> element.
       #
       def write_metadata_types
-        attributes = [['count', 1 ]]
+        attributes = [['count', 1]]
 
         @writer.tag_elements('metadataTypes', attributes) do
           # Write the metadataType element.
@@ -68,7 +70,7 @@ module Writexlsx
       #
       def write_metadata_type
         attributes = [
-          ['name',                'XLDAPR'],
+          %w[name XLDAPR],
           ['minSupportedVersion', 120000],
           ['copy',                1],
           ['pasteAll',            1],
@@ -91,7 +93,7 @@ module Writexlsx
       #
       def write_future_metadata
         attributes = [
-          ['name',  'XLDAPR'],
+          %w[name XLDAPR],
           ['count', 1]
         ]
 
@@ -99,7 +101,7 @@ module Writexlsx
           @writer.tag_elements('bk') do
             @writer.tag_elements('extLst') do
               # Write the ext element.
-              write_ext();
+              write_ext
             end
           end
         end
@@ -109,7 +111,7 @@ module Writexlsx
       # Write the <ext> element.
       #
       def write_ext
-        attributes = [[ 'uri', '{bdbb8cdc-fa1e-496e-a857-3c3f30c029c3}']]
+        attributes = [['uri', '{bdbb8cdc-fa1e-496e-a857-3c3f30c029c3}']]
         @writer.tag_elements('ext', attributes) do
           # Write the xda:dynamicArrayProperties element.
           write_xda_dynamic_array_properties

data/lib/write_xlsx/package/packager.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 require 'write_xlsx/package/app'
@@ -17,7 +19,6 @@ require 'write_xlsx/package/vml'
 module Writexlsx
   module Package
     class Packager
-
       include Writexlsx::Utility
 
       def initialize(workbook)
@@ -79,7 +80,6 @@ module Writexlsx
         @workbook.worksheets.write_worksheet_files(@package_dir)
       end
 
-      #
       def write_chartsheet_files
         @workbook.worksheets.write_chartsheet_files(@package_dir)
       end
@@ -103,7 +103,7 @@ module Writexlsx
 
         objects.each_with_index do |object, index|
           FileUtils.mkdir_p(dir)
-          object.set_xml_writer("#{dir}/#{filename}#{index+1}.xml")
+          object.set_xml_writer("#{dir}/#{filename}#{index + 1}.xml")
           object.assemble_xml_file
         end
       end
@@ -142,13 +142,12 @@ module Writexlsx
       def write_app_file
         app = Package::App.new(@workbook)
 
+        # Add the Worksheet parts.
+        app.add_worksheet_part_names
         # Add the Worksheet heading pairs.
         app.add_worksheet_heading_pairs
         # Add the Chartsheet heading pairs.
         app.add_chartsheet_heading_pairs
-
-        # Add the Worksheet parts.
-        app.add_worksheet_part_names
         # Add the Chartsheet parts.
         app.add_chartsheet_part_names
         # Add the Named Range heading pairs.
@@ -187,7 +186,7 @@ module Writexlsx
 
         FileUtils.mkdir_p("#{@package_dir}/xl")
 
-        metadata.set_xml_writer( "#{@package_dir}/xl/metadata.xml")
+        metadata.set_xml_writer("#{@package_dir}/xl/metadata.xml")
         metadata.assemble_xml_file
       end
 
@@ -246,7 +245,7 @@ module Writexlsx
 
         rels.set_style_properties(*@workbook.style_properties)
 
-        rels.set_xml_writer("#{dir}/styles.xml" )
+        rels.set_xml_writer("#{dir}/styles.xml")
         rels.assemble_xml_file
       end
 
@@ -279,15 +278,20 @@ module Writexlsx
 
         rels.add_document_relationship('/officeDocument', 'xl/workbook.xml')
 
-        rels.add_package_relationship('/metadata/core-properties',
-            'docProps/core.xml')
+        rels.add_package_relationship(
+          '/metadata/core-properties', 'docProps/core.xml'
+        )
 
-        rels.add_document_relationship('/extended-properties', 'docProps/app.xml')
+        rels.add_document_relationship(
+          '/extended-properties', 'docProps/app.xml'
+        )
 
         unless @workbook.custom_properties.empty?
-          rels.add_document_relationship('/custom-properties', 'docProps/custom.xml')
+          rels.add_document_relationship(
+            '/custom-properties', 'docProps/custom.xml'
+          )
         end
-        rels.set_xml_writer("#{@package_dir}/_rels/.rels" )
+        rels.set_xml_writer("#{@package_dir}/_rels/.rels")
         rels.assemble_xml_file
       end
 
@@ -304,10 +308,14 @@ module Writexlsx
 
         @workbook.worksheets.each do |worksheet|
           if worksheet.is_chartsheet?
-            rels.add_document_relationship('/chartsheet', "chartsheets/sheet#{chartsheet_index}.xml")
+            rels.add_document_relationship(
+              '/chartsheet', "chartsheets/sheet#{chartsheet_index}.xml"
+            )
             chartsheet_index += 1
           else
-            rels.add_document_relationship( '/worksheet', "worksheets/sheet#{worksheet_index}.xml")
+            rels.add_document_relationship(
+              '/worksheet', "worksheets/sheet#{worksheet_index}.xml"
+            )
             worksheet_index += 1
           end
         end
@@ -316,23 +324,29 @@ module Writexlsx
         rels.add_document_relationship('/styles', 'styles.xml')
 
         # Add the sharedString rel if there is string data in the workbook.
-        rels.add_document_relationship('/sharedStrings', 'sharedStrings.xml') unless @workbook.shared_strings_empty?
+        unless @workbook.shared_strings_empty?
+          rels.add_document_relationship(
+            '/sharedStrings', 'sharedStrings.xml'
+          )
+        end
 
         # Add vbaProject if present.
-        if @workbook.vba_project
-          rels.add_ms_package_relationship('/vbaProject', 'vbaProject.bin')
-        end
+        rels.add_ms_package_relationship('/vbaProject', 'vbaProject.bin') if @workbook.vba_project
 
         # Add the metadata file if required.
-        rels.add_document_relationship('/sheetMetadata', 'metadata.xml') if @workbook.has_metadata?
+        if @workbook.has_metadata?
+          rels.add_document_relationship(
+            '/sheetMetadata', 'metadata.xml'
+          )
+        end
 
         rels.set_xml_writer("#{@package_dir}/xl/_rels/workbook.xml.rels")
         rels.assemble_xml_file
       end
 
       #
-      # Write the worksheet .rels files for worksheets that contain links to external
-      # data such as hyperlinks or drawings.
+      # Write the worksheet .rels files for worksheets that contain links to
+      # external data such as hyperlinks or drawings.
       #
       def write_worksheet_rels_files
         @workbook.worksheets.write_worksheet_rels_files(@package_dir)
@@ -346,13 +360,13 @@ module Writexlsx
       end
 
       #
-      # Write the drawing .rels files for worksheets that contain charts or drawings.
+      # Write the drawing .rels files for worksheets that contain charts or
+      # drawings.
       #
       def write_drawing_rels_files
         @workbook.worksheets.write_drawing_rels_files(@package_dir)
       end
 
-
       #
       # Write the /xl/media/image?.xml files.
       #
@@ -361,7 +375,7 @@ module Writexlsx
 
         @workbook.images.each_with_index do |image, index|
           FileUtils.mkdir_p(dir)
-          FileUtils.cp(image[0], "#{dir}/image#{index+1}.#{image[1]}")
+          FileUtils.cp(image[0], "#{dir}/image#{index + 1}.#{image[1]}")
         end
       end
 

data/lib/write_xlsx/package/relationships.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
     class Relationships
-
       include Writexlsx::Utility
 
       Schema_root     = 'http://schemas.openxmlformats.org'

data/lib/write_xlsx/package/shared_strings.rb

@@ -1,21 +1,24 @@
 # -*- coding: utf-8 -*-
 # frozen_string_literal: true
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
     class SharedStrings
-
       include Writexlsx::Utility
 
       PRESERVE_SPACE_ATTRIBUTES = ['xml:space', 'preserve'].freeze
 
+      attr_reader :strings
+
       def initialize
         @writer        = Package::XMLWriterSimple.new
         @strings       = [] # string table
         @strings_index = {} # string table index
         @count         = 0 # count
+        @str_unique    = 0
       end
 
       def index(string, params = {})
@@ -25,10 +28,9 @@ module Writexlsx
 
       def add(string)
         unless @strings_index[string]
-          # Only first time the string will be append to list
-          # next time we only check and not #dup it
-          str = string.dup.freeze
+          str = string.frozen? ? string : string.freeze
           @strings << str
+          @str_unique += 1
           @strings_index[str] = @strings.size - 1
         end
         @count += 1
@@ -58,7 +60,7 @@ module Writexlsx
       #
       # Write the <sst> element.
       #
-      def write_sst
+      def write_sst(&block)
         schema       = 'http://schemas.openxmlformats.org'
 
         attributes =
@@ -68,7 +70,7 @@ module Writexlsx
             ['uniqueCount', unique_count]
           ]
 
-        @writer.tag_elements('sst', attributes) { yield }
+        @writer.tag_elements('sst', attributes, &block)
       end
 
       #
@@ -93,21 +95,21 @@ module Writexlsx
         string = string.gsub(/(_x[0-9a-fA-F]{4}_)/, '_x005F\1')
 
         # Convert control character to the _xHHHH_ escape.
-        string = string.gsub(
-          /([\x00-\x08\x0B-\x1F])/,
-          sprintf("_x%04X_", $1.ord)
-        ) if string =~ /([\x00-\x08\x0B-\x1F])/
+        if string =~ /([\x00-\x08\x0B-\x1F])/
+          string = string.gsub(
+            /([\x00-\x08\x0B-\x1F])/,
+            sprintf("_x%04X_", ::Regexp.last_match(1).ord)
+          )
+        end
 
         # Convert character to \xC2\xxx or \xC3\xxx
-        if string.bytesize == 1 && 0x80 <= string.ord && string.ord <= 0xFF
-          string = add_c2_c3(string)
-        end
+        string = add_c2_c3(string) if string.bytesize == 1 && 0x80 <= string.ord && string.ord <= 0xFF
 
         # Add attribute to preserve leading or trailing whitespace.
         attributes << PRESERVE_SPACE_ATTRIBUTES if string =~ /\A\s|\s\Z/
 
         # Write any rich strings without further tags.
-        if string =~ %r{^<r>} && string =~ %r{</r>$}
+        if string =~ /^<r>/ && string =~ %r{</r>$}
           @writer.si_rich_element(string)
         else
           @writer.si_element(string, attributes)
@@ -128,7 +130,7 @@ module Writexlsx
       end
 
       def unique_count
-        @strings.size
+        @str_unique
       end
     end
   end