write_xlsx 0.85.10 → 0.85.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ee9d7976dffd23442ab3dc1c87eb79d11786b5c6c9747f805a018a22330698
-  data.tar.gz: 43c1478b3d812cc7ba3d3d616b9fe9c14ef58b0e63c565d3d90378cdad6cdb92
+  metadata.gz: 89f382bd2df994369316a0422365541984f53ec084c5d3bb1c5d5a03523757a9
+  data.tar.gz: 363697c51b2250602fd5122aa3e9c7a6c71ec755a671e659f08f19c58b184792
 SHA512:
-  metadata.gz: 626c6f160305d4a67487c10174d45daf37cd7e9eef9736f5d6adbf44219e0aa996f52dc07564b3124141cc94d3d286acf9631176b913cf91e733de8ef0fda16d
-  data.tar.gz: a1d8170e68cbd7ee0f06a5b9ea00aa801bf990a6a06090ce0abe275bd84bd8c1201740e30735b887761a57e0d28357431e6a3d5a5e17a995b6fe2d5ff2c7a43a
+  metadata.gz: c719aa61decdc25064a72704d015d8a1eea48b3a94ccb7ccaf01e99456a6521c5c4fc5a5ee738a721c1e06c4632c737cf47d14afd3830a164162a789acc6e452
+  data.tar.gz: 96f55161f36511ef22708a377ea647f21f4ae76c978039b0c85c32c5db55ac0330f3e4c7a0e1f030d60c3d00c0c96f6c3f045bbfd240a2e2031c8ced2b2c2945

data/Changes

@@ -1,5 +1,8 @@
 Change history of write_xlsx rubygem.
 
+2020-10-23 v0.85.11
+   Added Worksheet#update_range_format_with_params
+
 2020-10-23 v0.85.10
    Fix frozen string litterals problems in Format#set_align
 

data/README.md

@@ -84,7 +84,7 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 ## Copyright
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
-Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp)
+Converted to ruby by Hideo NAKAMURA(nakamrua.hideo@gmail.com)
 Copyright (c) 2012-2018 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.

data/examples/update_range_format_with_params.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A simple example of how to use the write_xlsx gem to
+# update format of the range of cells.
+#
+
+require 'write_xlsx'
+
+workbook = WriteXLSX.new('update_range_format_with_params.xlsx')
+worksheet = workbook.add_worksheet
+
+common_format = workbook.add_format(align: 'center', border: 1)
+
+table_contents = [
+  ['Table', 'Header', 'Contents'],
+  ['table', 'body', 'contents'],
+  ['table', 'body', 'contents'],
+  ['table', 'body', 'contents']
+]
+
+worksheet.write_col(0, 0, table_contents, common_format)
+worksheet.update_range_format_with_params(
+  0, 0, 0, 2,
+  bold: 1, top: 2, bottom: 2, bg_color: 31
+)
+worksheet.update_range_format_with_params(0, 0, 3, 0, left: 2)
+worksheet.update_range_format_with_params(0, 2, 3, 2, right: 2)
+worksheet.update_range_format_with_params(3, 0, 3, 2, bottom: 2)
+
+workbook.close

data/lib/write_xlsx/version.rb

@@ -1 +1 @@
-WriteXLSX_VERSION = "0.85.10"
+WriteXLSX_VERSION = "0.85.11"

data/lib/write_xlsx/worksheet.rb

@@ -2528,6 +2528,91 @@ def write_array_formula(*args)
       end
     end
 
+    #
+    # :call-seq:
+    #   update_format_with_params(row, col, format_params)
+    #
+    # Update formatting of the cell to the specified row and column (zero indexed).
+    #
+    #     worksheet.update_format_with_params(0, 0, color: 'red')
+    #
+    # This method is used to update formatting of the cell keeping cell contents 
+    # and formatting.
+    #
+    # If the cell doesn't have CellData object, this method create a CellData 
+    # using write_blank method.
+    # If the cell has CellData, this method fetch contents and format of cell from 
+    # the CellData object and recreate CellData using write method.
+    #
+    def update_format_with_params(*args)
+      row, col, params = row_col_notation(args)
+      raise WriteXLSXInsufficientArgumentError if row.nil? || col.nil? || params.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)
+
+      format = nil
+      cell_data = nil
+      if @cell_data_table[row].nil? || @cell_data_table[row][col].nil?
+        format = @workbook.add_format(params)
+        write_blank(row, col, format)
+      else
+        if @cell_data_table[row][col].xf.nil?
+          format = @workbook.add_format(params)
+          cell_data = @cell_data_table[row][col]
+        else
+          format = @workbook.add_format
+          cell_data = @cell_data_table[row][col]
+          format.copy(cell_data.xf)
+          format.set_format_properties(params)
+        end
+        # keep original value of cell
+        if cell_data.is_a? FormulaCellData
+          value = "=#{cell_data.token}"
+        elsif cell_data.is_a? FormulaArrayCellData
+          value = "{=#{cell_data.token}}"
+        elsif cell_data.is_a? StringCellData
+          value = @workbook.shared_strings.string(cell_data.data[:sst_id])
+        else
+          value = cell_data.data
+        end
+        write(row, col, value, format)
+      end
+    end
+
+    #
+    # :call-seq:
+    #   update_range_format_with_params(row_first, col_first, row_last, col_last, format_params)
+    #
+    # Update formatting of cells in range to the specified row and column (zero indexed).
+    #
+    #     worksheet.update_range_format_with_params(0, 0, 3, 3, color: 'red')
+    #
+    # This method is used to update formatting of multiple cells keeping cells' contents 
+    # and formatting.
+    #
+    #
+    def update_range_format_with_params(*args)
+      row_first, col_first, row_last, col_last, params = row_col_notation(args)
+
+      raise WriteXLSXInsufficientArgumentError if [row_first, col_first, row_last, col_last, params].include?(nil)
+
+      # Swap last row/col with first row/col as necessary
+      row_first,  row_last  = row_last,  row_first  if row_first > row_last
+      col_first, col_last = col_last, col_first if col_first > col_last
+
+      # Check that column number is valid and store the max value
+      check_dimensions(row_last, col_last)
+      store_row_col_max_min_values(row_last, col_last)
+
+      (row_first..row_last).each do |row|
+        (col_first..col_last).each do |col|
+          update_format_with_params(row, col, params)
+        end
+      end
+    end
+
     #
     # The outline_settings() method is used to control the appearance of
     # outlines in Excel. Outlines are described in

data/test/regression/test_update_range_format_with_params.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestUpdateRangeFormatWithParams < Test::Unit::TestCase
+  def setup
+    setup_dir_var
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_update_range_format_with_params
+    @xlsx = 'update_range_format_with_params.xlsx'
+    workbook  = WriteXLSX.new(@io)
+    worksheet = workbook.add_worksheet
+
+    common_format = workbook.add_format(align: 'center', border: 1)
+
+    table_contents = [
+      ['Table', 'Header', 'Contents'],
+      ['table', 'body', 'contents'],
+      ['table', 'body', 'contents'],
+      ['table', 'body', 'contents']
+    ]
+
+    worksheet.write_col(0, 0, table_contents, common_format)
+    worksheet.update_range_format_with_params(
+      0, 0, 0, 2,
+      bold: 1, top: 2, bottom: 2, bg_color: 31
+    )
+    worksheet.update_range_format_with_params(0, 0, 3, 0, left: 2)
+    worksheet.update_range_format_with_params(0, 2, 3, 2, right: 2)
+    worksheet.update_range_format_with_params(3, 0, 3, 2, bottom: 2)
+
+    workbook.close
+    compare_for_regression(
+      nil,
+      {'xl/workbook.xml' => ['<workbookView']}
+    )
+  end
+end

data/test/worksheet/test_update_format_methods.rb

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+require 'write_xlsx'
+require 'stringio'
+
+class TestUpdateFormatMethods < Test::Unit::TestCase
+  def setup
+    @workbook = WriteXLSX.new(StringIO.new)
+    @worksheet = @workbook.add_worksheet('')
+  end
+
+  def test_update_format_with_params_with_insufficient_args_raise_InsufficientArgumentError
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_format_with_params
+    end
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_format_with_params(0)
+    end
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_format_with_params('A1')
+    end
+  end
+
+  def test_update_format_with_params_with_valid_arg_not_raise
+    assert_nothing_raised do
+      @worksheet.update_format_with_params(0, 0, color: 'red', border: 2)
+    end
+    assert_nothing_raised do
+      @worksheet.update_format_with_params('B2', align: 'center')
+    end
+  end
+
+  def test_update_format_with_params_should_write_blank_when_there_is_no_CellData
+    assert_nil(@worksheet.instance_variable_get(:@cell_data_table)[0])
+    @worksheet.update_format_with_params(0, 0, left: 4)
+    assert @worksheet.instance_variable_get(:@cell_data_table)[0][0] != nil
+  end
+
+  def test_update_format_with_params_should_keep_data_when_updating_format
+    number = 153
+    @worksheet.write(0, 0, number)
+    @worksheet.update_format_with_params(0, 0, bg_color: 'gray')
+    assert_equal(@worksheet.instance_variable_get(:@cell_data_table)[0][0].data, number)
+
+    string = 'Hello, World!'
+    @worksheet.write(0, 0, string)
+    @worksheet.update_format_with_params(0, 0, bg_color: 'gray')
+    written_string = @workbook.shared_strings.string(@worksheet.instance_variable_get(:@cell_data_table)[0][0].data[:sst_id])
+    assert_equal(written_string, string)
+
+    formula = '=1+1'
+    @worksheet.write(0, 0, formula)
+    @worksheet.update_format_with_params(0, 0, bg_color: 'gray')
+    assert_equal(@worksheet.instance_variable_get(:@cell_data_table)[0][0].token, '1+1')
+
+    array_formula = '{=SUM(B1:C1*B2:C2)}'
+    @worksheet.write('A1', array_formula)
+    @worksheet.update_format_with_params(0, 0, bg_color: 'gray')
+    assert_equal(@worksheet.instance_variable_get(:@cell_data_table)[0][0].token, 'SUM(B1:C1*B2:C2)')
+
+    url = 'https://www.writexlsx.io'
+    @worksheet.write(0, 0, url)
+    @worksheet.update_format_with_params(0, 0, bg_color: 'gray')
+    written_string = @workbook.shared_strings.string(@worksheet.instance_variable_get(:@cell_data_table)[0][0].data[:sst_id])
+    assert_equal(written_string, url)
+
+    string = 'Hello, World!'
+    format = @workbook.add_format(color: 'white')
+    @worksheet.write(0, 0, string, format)
+    @worksheet.update_format_with_params(0, 0, bg_color: 'gray')
+    written_string = @workbook.shared_strings.string(@worksheet.instance_variable_get(:@cell_data_table)[0][0].data[:sst_id])
+    assert_equal(written_string, string)
+  end
+
+  def test_update_format_with_params_should_not_update_other_cells_format
+    format = @workbook.add_format(bold: 1)
+    @worksheet.write_row(0, 0, ['', '', '', '', ''], format)
+    @worksheet.update_format_with_params(0, 0, bold: 0)
+    assert_not_equal(@worksheet.instance_variable_get(:@cell_data_table)[0][0].xf, 
+                     @worksheet.instance_variable_get(:@cell_data_table)[0][1].xf )
+    assert_equal(@worksheet.instance_variable_get(:@cell_data_table)[0][0].xf.bold, 0)
+    assert_equal(@worksheet.instance_variable_get(:@cell_data_table)[0][1].xf.bold, 1)
+  end
+
+  def test_update_range_format_with_params_with_insufficient_args_raise_InsufficientArgumentError
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_range_format_with_params
+    end
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_range_format_with_params(0, 0)
+    end
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_range_format_with_params('A1')
+    end
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_range_format_with_params(0, 0, 3, 3)
+    end
+    assert_raise(WriteXLSXInsufficientArgumentError) do
+      @worksheet.update_range_format_with_params('A2:C2')
+    end
+  end
+
+  def test_update_range_format_with_params_with_valid_arg_not_raise
+    assert_nothing_raised do
+      @worksheet.update_range_format_with_params(0, 0, 3, 3, bold: 1)
+    end
+    assert_nothing_raised do
+      @worksheet.update_range_format_with_params('A2:D5', bold: 1)
+    end
+  end
+end

data/write_xlsx.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.name          = "write_xlsx"
   gem.version       = WriteXLSX_VERSION
   gem.authors       = ["Hideo NAKAMURA"]
-  gem.email         = ["cxn03651@msj.biglobe.ne.jp"]
+  gem.email         = ["nakamura.hideo@gmail.com"]
   gem.description   = "write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format."
   gem.summary       = "write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format."
   gem.homepage = "http://github.com/cxn03651/write_xlsx#readme"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: write_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.85.10
+  version: 0.85.11
 platform: ruby
 authors:
 - Hideo NAKAMURA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -68,7 +68,7 @@ dependencies:
         version: '0'
 description: write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format.
 email:
-- cxn03651@msj.biglobe.ne.jp
+- nakamura.hideo@gmail.com
 executables:
 - extract_vba.rb
 extensions: []
@@ -154,6 +154,7 @@ files:
 - examples/stocks.rb
 - examples/tab_colors.rb
 - examples/tables.rb
+- examples/update_range_format_with_params.rb
 - examples/vbaProject.bin
 - lib/write_xlsx.rb
 - lib/write_xlsx/chart.rb
@@ -978,6 +979,7 @@ files:
 - test/regression/test_tutorial01.rb
 - test/regression/test_tutorial02.rb
 - test/regression/test_tutorial03.rb
+- test/regression/test_update_range_format_with_params.rb
 - test/regression/test_urls_as_strings.rb
 - test/regression/test_utf8_01.rb
 - test/regression/test_utf8_03.rb
@@ -1561,6 +1563,7 @@ files:
 - test/regression/xlsx_files/tutorial01.xlsx
 - test/regression/xlsx_files/tutorial02.xlsx
 - test/regression/xlsx_files/tutorial03.xlsx
+- test/regression/xlsx_files/update_range_format_with_params.xlsx
 - test/regression/xlsx_files/urls_as_strings.xlsx
 - test/regression/xlsx_files/utf8_01.xlsx
 - test/regression/xlsx_files/utf8_03.xlsx
@@ -1636,6 +1639,7 @@ files:
 - test/worksheet/test_sparkline_09.rb
 - test/worksheet/test_sparkline_10.rb
 - test/worksheet/test_sparkline_11.rb
+- test/worksheet/test_update_format_methods.rb
 - test/worksheet/test_worksheet_01.rb
 - test/worksheet/test_worksheet_02.rb
 - test/worksheet/test_worksheet_03.rb
@@ -2491,6 +2495,7 @@ test_files:
 - test/regression/test_tutorial01.rb
 - test/regression/test_tutorial02.rb
 - test/regression/test_tutorial03.rb
+- test/regression/test_update_range_format_with_params.rb
 - test/regression/test_urls_as_strings.rb
 - test/regression/test_utf8_01.rb
 - test/regression/test_utf8_03.rb
@@ -3074,6 +3079,7 @@ test_files:
 - test/regression/xlsx_files/tutorial01.xlsx
 - test/regression/xlsx_files/tutorial02.xlsx
 - test/regression/xlsx_files/tutorial03.xlsx
+- test/regression/xlsx_files/update_range_format_with_params.xlsx
 - test/regression/xlsx_files/urls_as_strings.xlsx
 - test/regression/xlsx_files/utf8_01.xlsx
 - test/regression/xlsx_files/utf8_03.xlsx
@@ -3149,6 +3155,7 @@ test_files:
 - test/worksheet/test_sparkline_09.rb
 - test/worksheet/test_sparkline_10.rb
 - test/worksheet/test_sparkline_11.rb
+- test/worksheet/test_update_format_methods.rb
 - test/worksheet/test_worksheet_01.rb
 - test/worksheet/test_worksheet_02.rb
 - test/worksheet/test_worksheet_03.rb