write_xlsx 0.85.3 → 0.85.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 451a49314f7a14e2c9d5bfc5c4df3ca7f54e2718
-  data.tar.gz: 040af462094068f22464c341ea38fa971b5e4403
+SHA256:
+  metadata.gz: 1a8ed1e139d973baf49fc349d874da19de256e10ac34f2b4f5a08ec6dcac1eba
+  data.tar.gz: a553667cbe7443f9c9bbfc74d28a9a30e830c95dec213e2d70ca48862bb0505a
 SHA512:
-  metadata.gz: 47524ba5498e8529ccc789da00036e0cf7a901d116f6661c75d8ee7b74485181aeb5ee7f657844cdbf756a1dfaa6337faf25c307586960fb32465fcca4764249
-  data.tar.gz: b582ea2f76e0bf02a37484581d732c9a329161d606fae13a381cd6541824b0a4ee061f8196385277a4e8b92f0965db79b5d426bf77cc7107201f55f18b1e0b76
+  metadata.gz: ec4e891ca22e53564f6a715aca9efce06c19782a4274d71ddb485b2bc34f1bf4f11a5f70b736b5fd4f23d74b47e68235c8ef4781fd3c014cad7cbf7c07501963
+  data.tar.gz: e262a4b65b0da4703894ab831f36a1058dcae5d71d103d7f83c313c0ada4e30db534eaabc3273b4c784c1b06d14de4730506b142ea49c8dc32c283339604f0c3

data/.gitignore

@@ -1,4 +1,7 @@
 TAGS
+GPATH
+GRTAGS
+GTAGS
 *.gem
 .bundle
 .config

data/Changes

@@ -1,5 +1,20 @@
 Change history of write_xlsx rubygem.
 
+2020-09-03 v0.85.8
+   apply pull-request #58 and #52
+
+2019-06-20 v0.85.7
+   apply pull-request #26
+
+2019-02-10 v0.85.6
+   Fix work well in ms windows.
+
+2018-04-29 v0.85.5
+   Added option to store hyperlink strings as string (strings_as_urls: false).
+
+2018-04-29 v0.85.4
+   Added option to store hyperlink strings as string (urls_as_strings).
+
 2018-01-07 v0.85.3
    Fix hide first sheet problem #37
 

data/Rakefile

@@ -7,5 +7,5 @@ require 'rake/testtask'
 Rake::TestTask.new do |test|
   test.libs << 'test'
   test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+  test.warning = false
 end

data/lib/write_xlsx/compatibility.rb

@@ -45,7 +45,7 @@ def ascii_only?
 
 unless File.respond_to?(:binread)
   def File.binread(file) #:nodoc:
-    File.open(file,"rb") { |f| f.read }
+    File.open(file,"rb:utf-8:utf-8") { |f| f.read }
   end
 end
 

data/lib/write_xlsx/format.rb

@@ -287,11 +287,10 @@ def set_format_properties(*properties)   # :nodoc:
 
           # Create a sub to set the property.
           if value.respond_to?(:to_str) || !value.respond_to?(:+)
-            s = "set_#{key}('#{value}')"
+            send("set_#{key}", value.to_s)
           else
-            s = "set_#{key}(#{value})"
+            send("set_#{key}", value)
           end
-          eval s
         end
       end
     end

data/lib/write_xlsx/package/shared_strings.rb

@@ -9,14 +9,15 @@ class SharedStrings
       include Writexlsx::Utility
 
       def initialize
-        @writer  = Package::XMLWriterSimple.new
-        @strings = [] # string table
-        @count   = {} # => count
+        @writer        = Package::XMLWriterSimple.new
+        @strings       = [] # string table
+        @strings_index = {} # string table index
+        @count         = {} # count
       end
 
       def index(string, params = {})
         add(string) unless params[:only_query]
-        @strings.index(string)
+        @strings_index[string]
       end
 
       def add(string)
@@ -25,6 +26,7 @@ def add(string)
           @count[str] += 1
         else
           @strings << str
+          @strings_index[str] = @strings.size - 1
           @count[str] = 1
         end
       end

data/lib/write_xlsx/package/xml_writer_simple.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 #
 # XMLWriterSimple
 #
@@ -29,10 +30,9 @@ def tag_elements(tag, attributes = [])
       end
 
       def tag_elements_str(tag, attributes = [])
-        str = ''
-        str << start_tag_str(tag, attributes)
-        str << yield
-        str << end_tag_str(tag)
+        str = start_tag_str(tag, attributes) +
+              yield +
+              end_tag_str(tag)
       end
 
       def start_tag(tag, attr = [])
@@ -65,7 +65,7 @@ def empty_tag_encoded_str(tag, attr = [])
       end
 
       def data_element(tag, data, attr = [])
-        tag_elements(tag, attr) { io_write("#{escape_data(data)}") }
+        tag_elements(tag, attr) { io_write(escape_data(data)) }
       end
 
       #
@@ -92,7 +92,7 @@ def crlf
 
       def close
         if @filename
-          File.open(@filename, "wb") { |f| f << string }
+          File.open(@filename, "wb:utf-8:utf-8") { |f| f << string }
         end
         @io.close
       end

data/lib/write_xlsx/utility.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/col_name'
 
 module Writexlsx
@@ -303,11 +304,12 @@ def write_color(writer, name, value) #:nodoc:
       writer.empty_tag('color', attributes)
     end
 
+    PERL_TRUE_VALUES = [false, nil, 0, "0", "", [], {}].freeze
     #
     # return perl's boolean result
     #
     def ptrue?(value)
-      if [false, nil, 0, "0", "", [], {}].include?(value)
+      if PERL_TRUE_VALUES.include?(value)
         false
       else
         true
@@ -586,7 +588,7 @@ def process_workbook_options(*params)
       when 0
         [{}, {}]
       when 1 # one hash
-        options_keys = [:tempdir, :date_1904, :optimization, :excel2003_style]
+        options_keys = [:tempdir, :date_1904, :optimization, :excel2003_style, :strings_to_urls]
 
         hash = params.first
         options = hash.reject{|k,v| !options_keys.include?(k)}

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.85.3"
+WriteXLSX_VERSION = "0.85.8"

data/lib/write_xlsx/workbook.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/package/packager'
 require 'write_xlsx/sheets'
@@ -47,6 +48,7 @@ class Workbook
     attr_reader :shared_strings  # :nodoc:
     attr_reader :vba_project  # :nodoc:
     attr_reader :excel2003_style # :nodoc:
+    attr_reader :strings_to_urls # :nodoc:
     #
     # A new Excel workbook is created using the +new+ constructor
     # which accepts either a filename or an IO object as a parameter.
@@ -123,6 +125,7 @@ def initialize(file, *option_params)
       @table_count         = 0
       @image_types         = {}
       @images              = []
+      @strings_to_urls     = (options[:strings_to_urls].nil? || options[:strings_to_urls]) ? true : false
 
       # Structures for the shared strings data.
       @shared_strings = Package::SharedStrings.new
@@ -970,8 +973,9 @@ def date_1904? #:nodoc:
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
     #
-    def shared_string_index(str, params = {}) #:nodoc:
-      @shared_strings.index(str, params)
+    EMPTY_HASH = {}.freeze
+    def shared_string_index(str) #:nodoc:
+      @shared_strings.index(str, EMPTY_HASH)
     end
 
     def str_unique   # :nodoc:

data/lib/write_xlsx/worksheet.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/package/button'
 require 'write_xlsx/colors'
@@ -1783,15 +1784,6 @@ def write(*args)
         write_number(*args)
       elsif token =~ /^\d+$/
         write_number(*args)
-      # Match http, https or ftp URL
-      elsif token =~ %r|\A[fh]tt?ps?://|
-        write_url(*args)
-      # Match mailto:
-      elsif token =~ %r|\Amailto:|
-        write_url(*args)
-      # Match internal or external sheet link
-      elsif token =~ %r!\A(?:in|ex)ternal:!
-        write_url(*args)
       # Match formula
       elsif token =~ /^=/
         write_formula(*args)
@@ -1802,6 +1794,19 @@ def write(*args)
       elsif token == ''
         row_col_args.delete_at(2)     # remove the empty string from the parameter list
         write_blank(*row_col_args)
+      elsif @workbook.strings_to_urls
+        # Match http, https or ftp URL
+        if token =~ %r|\A[fh]tt?ps?://|
+          write_url(*args)
+        # Match mailto:
+        elsif token =~ %r|\Amailto:|
+          write_url(*args)
+        # Match internal or external sheet link
+        elsif token =~ %r!\A(?:in|ex)ternal:!
+          write_url(*args)
+        else
+          write_string(*args)
+        end
       else
         write_string(*args)
       end
@@ -2184,7 +2189,7 @@ def write_comment(*args)
     def write_number(*args)
       # Check for a cell reference in A1 notation and substitute row and column
       row, col, num, xf = row_col_notation(args)
-      raise WriteXLSXInsufficientArgumentError if [row, col, num].include?(nil)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil? || num.nil?
 
       # Check that row and col are valid and store max and min values
       check_dimensions(row, col)
@@ -2226,13 +2231,13 @@ def write_string(*args)
       # Check for a cell reference in A1 notation and substitute row and column
       row, col, str, xf = row_col_notation(args)
       str &&= str.to_s
-      raise WriteXLSXInsufficientArgumentError if [row, col, str].include?(nil)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil? || str.nil?
 
       # Check that row and col are valid and store max and min values
       check_dimensions(row, col)
       store_row_col_max_min_values(row, col)
 
-      index = shared_string_index(str[0, STR_MAX])
+      index = shared_string_index(str.length > STR_MAX ? str[0, STR_MAX] : str)
 
       store_data_to_table(StringCellData.new(self, row, col, index, xf))
     end
@@ -5845,10 +5850,11 @@ def prepare_vml_objects(vml_data_id, vml_shape_id, vml_drawing_id, comment_id)
 
       # The VML o:idmap data id contains a comma separated range when there is
       # more than one 1024 block of comments, like this: data="1,2".
+      data = "#{vml_data_id}"
       (1 .. num_comments_block).each do |i|
-        vml_data_id = "#{vml_data_id},#{vml_data_id + i}"
+        data += ",#{vml_data_id + i}"
       end
-      @vml_data_id = vml_data_id
+      @vml_data_id = data
       @vml_shape_id = vml_shape_id
     end
 
@@ -7505,8 +7511,8 @@ def calc_spans(data, row_num, span_min, span_max)
     # Add a string to the shared string table, if it isn't already there, and
     # return the string index.
     #
-    def shared_string_index(str, params = {}) #:nodoc:
-      @workbook.shared_string_index(str, params)
+    def shared_string_index(str) #:nodoc:
+      @workbook.shared_string_index(str)
     end
 
     #

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 module Writexlsx
   class Worksheet
@@ -63,9 +64,10 @@ def data
         { :sst_id => token }
       end
 
+      TYPE_STR_ATTRS = ['t', 's'].freeze
       def write_cell
         attributes = cell_attributes
-        attributes << ['t', 's']
+        attributes << TYPE_STR_ATTRS
         @worksheet.writer.tag_elements('c', attributes) do
           @worksheet.write_cell_value(token)
         end

data/lib/write_xlsx/worksheet/hyperlink.rb

@@ -24,7 +24,7 @@ def initialize(url, str, tip)
         str ||= url.dup
 
         # Strip the mailto header.
-        str.sub!(/^mailto:/, '')
+        normalized_str = str.sub(/^mailto:/, '')
 
         # Escape URL unless it looks already escaped.
         url = escape_url(url)
@@ -35,7 +35,7 @@ def initialize(url, str, tip)
         end
 
         @url       = url
-        @str       = str
+        @str       = normalized_str
         @url_str   = nil
         @tip       = tip
       end

data/test/helper.rb

@@ -13,6 +13,9 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'write_xlsx'
+require 'stringio'
+require 'tempfile'
+
 
 class Writexlsx::Workbook
   #
@@ -28,6 +31,11 @@ def setup_dir_var
     @test_dir = File.dirname(__FILE__)
     @perl_output  = File.join(@test_dir, 'perl_output')
     @regression_output  = File.join(@test_dir, 'regression', 'xlsx_files')
+    @io = StringIO.new
+  end
+
+  def expected_xlsx
+    File.join(@regression_output, @xlsx)
   end
 
   def expected_to_array(lines)
@@ -68,6 +76,18 @@ def entrys(xlsx)
     result
   end
 
+  def compare_for_regression(ignore_members = nil, ignore_elements = nil)
+    store_to_tempfile
+    compare_xlsx(expected_xlsx, @tempfile.path, ignore_members, ignore_elements, true)
+  end
+
+  def store_to_tempfile
+    @tempfile = Tempfile.open(@xlsx)
+    @tempfile.binmode
+    @tempfile.write(@io.string)
+    @tempfile.close
+  end
+
   def compare_xlsx_for_regression(exp_filename, got_filename, ignore_members = nil, ignore_elements = nil)
     compare_xlsx(exp_filename, got_filename, ignore_members, ignore_elements, true)
   end

data/test/regression/disabled_test_vml04.rb

@@ -12,7 +12,7 @@ def teardown
 
   def test_vml04
     @xlsx = 'vml04.xlsx'
-    workbook   = WriteXLSX.new(@xlsx)
+    workbook   = WriteXLSX.new(@io)
     worksheet1 = workbook.add_worksheet
     worksheet2 = workbook.add_worksheet
     worksheet3 = workbook.add_worksheet
@@ -36,6 +36,6 @@ def test_vml04
     worksheet3.insert_button('E8', {})
 
     workbook.close
-    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx)
+    compare_for_regression
   end
 end

data/test/regression/test_array_formula01.rb

@@ -7,12 +7,12 @@ def setup
   end
 
   def teardown
-    File.delete(@xlsx) if File.exist?(@xlsx)
+    @tempfile.close(true)
   end
 
   def test_array_formula01
     @xlsx = 'array_formula01.xlsx'
-    workbook  = WriteXLSX.new(@xlsx)
+    workbook  = WriteXLSX.new(@io)
     worksheet = workbook.add_worksheet
 
     data = [0, 0, 0]
@@ -23,9 +23,9 @@ def test_array_formula01
     worksheet.write_array_formula('A1:A3', '{=SUM(B1:C1*B2:C2)}', nil, 0)
 
     workbook.close
-    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx,
-                                [ 'xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels' ],
-                                {'xl/workbook.xml' => ['<workbookView']}
-                                )
+    compare_for_regression(
+      [ 'xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels' ],
+      {'xl/workbook.xml' => ['<workbookView']}
+    )
   end
 end

data/test/regression/test_array_formula02.rb

@@ -7,12 +7,12 @@ def setup
   end
 
   def teardown
-    File.delete(@xlsx) if File.exist?(@xlsx)
+    @tempfile.close(true)
   end
 
   def test_array_formula02
     @xlsx = 'array_formula02.xlsx'
-    workbook  = WriteXLSX.new(@xlsx)
+    workbook  = WriteXLSX.new(@io)
     worksheet = workbook.add_worksheet
     format    = workbook.add_format(:bold => 1)
 
@@ -24,9 +24,9 @@ def test_array_formula02
     worksheet.write_array_formula('A1:A3', '{=SUM(B1:C1*B2:C2)}', format, 0)
 
     workbook.close
-    compare_xlsx_for_regression(File.join(@regression_output, @xlsx), @xlsx,
-                                [ 'xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels' ],
-                                {'xl/workbook.xml' => ['<workbookView']}
-                                )
+    compare_for_regression(
+      [ 'xl/calcChain.xml', '[Content_Types].xml', 'xl/_rels/workbook.xml.rels' ],
+      {'xl/workbook.xml' => ['<workbookView']}
+    )
   end
 end