This closes #1777, fix the GetStyle or GetConditionalStyle function t…

…o returns incorrect DecimalPlaces field value - Update documentation for the NewStyle function - Update unit tests - Update dependencies Go module - Update GitHub workflow dependencies package version - Update copyright agreement statement
qax-os · Jan 9, 2024 · 7926565 · 7926565
1 parent f4e3951
commit 7926565
Show file tree

Hide file tree

Showing 62 changed files with 209 additions and 74 deletions.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -24,12 +24,12 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
 
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -14,7 +14,7 @@ jobs:
     steps:
 
     - name: Install Go
-      uses: actions/setup-go@v4
+      uses: actions/setup-go@v5
       with:
         go-version: ${{ matrix.go-version }}
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2016-2023 The excelize Authors.
+Copyright (c) 2016-2024 The excelize Authors.
 Copyright (c) 2011-2017 Geoffrey J. Teale
 All rights reserved.
 

diff --git a/adjust.go b/adjust.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/calc.go b/calc.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/calcchain.go b/calcchain.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/cell.go b/cell.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/chart.go b/chart.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/col.go b/col.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/crypt.go b/crypt.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/crypt_test.go b/crypt_test.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/datavalidation.go b/datavalidation.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/datavalidation_test.go b/datavalidation_test.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/date.go b/date.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/docProps.go b/docProps.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/docProps_test.go b/docProps_test.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/drawing.go b/drawing.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/drawing_test.go b/drawing_test.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/errors.go b/errors.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/excelize.go b/excelize.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 

diff --git a/file.go b/file.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/go.mod b/go.mod
@@ -8,9 +8,9 @@ require (
 	github.com/stretchr/testify v1.8.4
 	github.com/xuri/efp v0.0.0-20231025114914-d1ff6096ae53
 	github.com/xuri/nfp v0.0.0-20230919160717-d98342af3f05
-	golang.org/x/crypto v0.17.0
+	golang.org/x/crypto v0.18.0
 	golang.org/x/image v0.14.0
-	golang.org/x/net v0.19.0
+	golang.org/x/net v0.20.0
 	golang.org/x/text v0.14.0
 )
 

diff --git a/go.sum b/go.sum
@@ -15,12 +15,12 @@ github.com/xuri/efp v0.0.0-20231025114914-d1ff6096ae53 h1:Chd9DkqERQQuHpXjR/HSV1
 github.com/xuri/efp v0.0.0-20231025114914-d1ff6096ae53/go.mod h1:ybY/Jr0T0GTCnYjKqmdwxyxn2BQf2RcQIIvex5QldPI=
 github.com/xuri/nfp v0.0.0-20230919160717-d98342af3f05 h1:qhbILQo1K3mphbwKh1vNm4oGezE1eF9fQWmNiIpSfI4=
 github.com/xuri/nfp v0.0.0-20230919160717-d98342af3f05/go.mod h1:WwHg+CVyzlv/TX9xqBFXEZAuxOPxn2k1GNHwG41IIUQ=
-golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
-golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
+golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
+golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
 golang.org/x/image v0.14.0 h1:tNgSxAFe3jC4uYqvZdTr84SZoM1KfwdC9SKIFrLjFn4=
 golang.org/x/image v0.14.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE=
-golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
-golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
+golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
+golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=

diff --git a/lib.go b/lib.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/merge.go b/merge.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/numfmt.go b/numfmt.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //
@@ -4680,6 +4680,67 @@ func (f *File) checkDateTimePattern() error {
 	return nil
 }
 
+// extractNumFmtDecimal returns decimal places, if has a decimal point token and
+// zero place holder token from a number format code token list.
+func extractNumFmtDecimal(tokens []nfp.Token) (int, bool, bool) {
+	decimal, point, zero := 0, false, false
+	for _, token := range tokens {
+		if token.TType == nfp.TokenTypeDecimalPoint {
+			point = true
+		}
+		if token.TType == nfp.TokenTypeZeroPlaceHolder {
+			if point {
+				decimal = len(token.TValue)
+			}
+			zero = true
+		}
+	}
+	return decimal, point, zero
+}
+
+// extractNumFmtDecimal returns decimal places from a number format code that
+// has the same decimal places in positive part negative part or only positive
+// part, if the given number format code is not suitable for numeric this
+// function will return -1.
+func (f *File) extractNumFmtDecimal(fmtCode string) int {
+	var (
+		p                                              = nfp.NumberFormatParser()
+		pos, neg, posPoint, negPoint, posZero, negZero bool
+		posDecimal, negDecimal                         int
+	)
+	for i, section := range p.Parse(fmtCode) {
+		if i == 0 {
+			pos = true
+			posDecimal, posPoint, posZero = extractNumFmtDecimal(section.Items)
+		}
+		if i == 1 {
+			neg = true
+			negDecimal, negPoint, negZero = extractNumFmtDecimal(section.Items)
+		}
+	}
+	if !pos {
+		return -1
+	}
+	equalPosNegDecimal := posPoint && negPoint && posDecimal == negDecimal
+	equalPosNegZero := !posPoint && !negPoint && posZero && negZero
+	if neg {
+		if equalPosNegDecimal {
+			return posDecimal
+		}
+		if equalPosNegZero {
+			return 0
+		}
+		return -1
+	}
+	if posPoint {
+		return posDecimal
+	}
+	if posZero {
+		return 0
+	}
+	return -1
+}
+
 // langNumFmtFuncZhCN returns number format code by given date and time pattern
 // for country code zh-cn.
 func (f *File) langNumFmtFuncZhCN(numFmtID int) string {

diff --git a/picture.go b/picture.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/pivotTable.go b/pivotTable.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/rows.go b/rows.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/shape.go b/shape.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/sheet.go b/sheet.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/sheetpr.go b/sheetpr.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/sheetview.go b/sheetview.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/slicer.go b/slicer.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/sparkline.go b/sparkline.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/stream.go b/stream.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //

diff --git a/styles.go b/styles.go
@@ -1,4 +1,4 @@
-// Copyright 2016 - 2023 The excelize Authors. All rights reserved. Use of
+// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of
 // this source code is governed by a BSD-style license that can be found in
 // the LICENSE file.
 //
@@ -278,6 +278,14 @@ func parseFormatStyleSet(style *Style) (*Style, error) {
 //	 single
 //	 double
 //
+// NumFmt is used to set the built-in all languages formats index, built-in
+// language formats index, or built-in currency formats index, it doesn't work
+// when you specify the custom number format by CustomNumFmt. When you get
+// style definition by the GetStyle or GetConditionalStyle function, the NumFmt
+// only works if the number format code is exactly equal with any built-in all
+// languages format code, built-in language formats code, or built-in currency
+// format code.
+//
 // Excel's built-in all languages formats are shown in the following table:
 //
 //	 Index | Format String
@@ -919,8 +927,8 @@ func parseFormatStyleSet(style *Style) (*Style, error) {
 //	 633   | ZWN
 //	 634   | ZWR
 //
-// Excelize support set custom number format for cell. For example, set number
-// as date type in Uruguay (Spanish) format for Sheet1!A6:
+// Excelize support set custom number format for cell by CustomNumFmt field. For
+// example, set number as date type in Uruguay (Spanish) format for Sheet1!A6:
 //
 //	f := excelize.NewFile()
 //	defer func() {
@@ -940,7 +948,15 @@ func parseFormatStyleSet(style *Style) (*Style, error) {
 //	}
 //	err = f.SetCellStyle("Sheet1", "A6", "A6", style)
 //
-// Cell Sheet1!A6 in the Excel Application: martes, 04 de Julio de 2017
+// Cell Sheet1!A6 in the spreadsheet application: martes, 04 de Julio de 2017
+//
+// DecimalPlaces is used to set the decimal places for built-in currency
+// formats, it doesn't work if you have specified the built-in all languages
+// formats or built-in language formats by NumFmt field, or specify the custom
+// number format by CustomNumFmt. When you get style definition by the GetStyle
+// or GetConditionalStyle function, the DecimalPlaces only doesn't nil if a
+// number format code has the same decimal places in the positive part negative
+// part, or only the positive part.
 func (f *File) NewStyle(style *Style) (int, error) {
 	var (
 		fs                                  *Style
@@ -1498,12 +1514,21 @@ func (f *File) extractFont(fnt *xlsxFont, s *xlsxStyleSheet, style *Style) {
 func (f *File) extractNumFmt(n *int, s *xlsxStyleSheet, style *Style) {
 	if n != nil {
 		numFmtID := *n
-		if _, ok := builtInNumFmt[numFmtID]; ok || isLangNumFmt(numFmtID) {
+		if builtInFmtCode, ok := builtInNumFmt[numFmtID]; ok || isLangNumFmt(numFmtID) {
 			style.NumFmt = numFmtID
+			if decimalPlaces := f.extractNumFmtDecimal(builtInFmtCode); decimalPlaces != -1 {
+				style.DecimalPlaces = &decimalPlaces
+			}
 			return
 		}
 		if s.NumFmts != nil {
 			for _, numFmt := range s.NumFmts.NumFmt {
+				if numFmt.NumFmtID != numFmtID {
+					continue
+				}
+				if decimalPlaces := f.extractNumFmtDecimal(numFmt.FormatCode); decimalPlaces != -1 {
+					style.DecimalPlaces = &decimalPlaces
+				}
 				style.CustomNumFmt = &numFmt.FormatCode
 				if strings.Contains(numFmt.FormatCode, ";[Red]") {
 					style.NegRed = true