From 53a495563a2b9acf09ae45eae05d5f33aa242a87 Mon Sep 17 00:00:00 2001 From: xuri Date: Thu, 29 Sep 2022 22:00:21 +0800 Subject: This closes #1358, made a refactor with breaking changes, see details: This made a refactor with breaking changes: Motivation and Context When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was: - There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure. - Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories - Nested properties cannot proceed modify easily Introduce 5 new export data types: `HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions` Rename 4 exported data types: - Rename `PivotTableOption` to `PivotTableOptions` - Rename `FormatHeaderFooter` to `HeaderFooterOptions` - Rename `FormatSheetProtection` to `SheetProtectionOptions` - Rename `SparklineOption` to `SparklineOptions` Remove 54 exported types: `AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale` Remove 2 exported constants: `OrientationPortrait` and `OrientationLandscape` Change 8 functions: - Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error` - Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)` - Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error` - Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)` - Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error` - Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)` - Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error` - Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)` Introduce new function to instead of existing functions: - New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOption --- sparkline_test.go | 71 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 34 deletions(-) (limited to 'sparkline_test.go') diff --git a/sparkline_test.go b/sparkline_test.go index 4703c85..e20dfdc 100644 --- a/sparkline_test.go +++ b/sparkline_test.go @@ -15,7 +15,10 @@ func TestAddSparkline(t *testing.T) { style, err := f.NewStyle(`{"font":{"bold":true}}`) assert.NoError(t, err) assert.NoError(t, f.SetCellStyle("Sheet1", "A1", "B1", style)) - assert.NoError(t, f.SetSheetViewOptions("Sheet1", 0, ZoomScale(150))) + viewOpts, err := f.GetSheetView("Sheet1", 0) + assert.NoError(t, err) + viewOpts.ZoomScale = float64Ptr(150) + assert.NoError(t, f.SetSheetView("Sheet1", 0, &viewOpts)) assert.NoError(t, f.SetColWidth("Sheet1", "A", "A", 14)) assert.NoError(t, f.SetColWidth("Sheet1", "B", "B", 50)) @@ -24,34 +27,34 @@ func TestAddSparkline(t *testing.T) { assert.NoError(t, f.SetCellValue("Sheet1", "B1", "Description")) assert.NoError(t, f.SetCellValue("Sheet1", "B2", `A default "line" sparkline.`)) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A2"}, Range: []string{"Sheet3!A1:J1"}, })) assert.NoError(t, f.SetCellValue("Sheet1", "B3", `A default "column" sparkline.`)) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A3"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", })) assert.NoError(t, f.SetCellValue("Sheet1", "B4", `A default "win/loss" sparkline.`)) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A4"}, Range: []string{"Sheet3!A3:J3"}, Type: "win_loss", })) assert.NoError(t, f.SetCellValue("Sheet1", "B6", "Line with markers.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A6"}, Range: []string{"Sheet3!A1:J1"}, Markers: true, })) assert.NoError(t, f.SetCellValue("Sheet1", "B7", "Line with high and low points.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A7"}, Range: []string{"Sheet3!A1:J1"}, High: true, @@ -59,7 +62,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B8", "Line with first and last point markers.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A8"}, Range: []string{"Sheet3!A1:J1"}, First: true, @@ -67,28 +70,28 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B9", "Line with negative point markers.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A9"}, Range: []string{"Sheet3!A1:J1"}, Negative: true, })) assert.NoError(t, f.SetCellValue("Sheet1", "B10", "Line with axis.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A10"}, Range: []string{"Sheet3!A1:J1"}, Axis: true, })) assert.NoError(t, f.SetCellValue("Sheet1", "B12", "Column with default style (1).")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A12"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", })) assert.NoError(t, f.SetCellValue("Sheet1", "B13", "Column with style 2.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A13"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", @@ -96,7 +99,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B14", "Column with style 3.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A14"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", @@ -104,7 +107,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B15", "Column with style 4.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A15"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", @@ -112,7 +115,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B16", "Column with style 5.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A16"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", @@ -120,7 +123,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B17", "Column with style 6.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A17"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", @@ -128,7 +131,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B18", "Column with a user defined color.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A18"}, Range: []string{"Sheet3!A2:J2"}, Type: "column", @@ -136,14 +139,14 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B20", "A win/loss sparkline.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A20"}, Range: []string{"Sheet3!A3:J3"}, Type: "win_loss", })) assert.NoError(t, f.SetCellValue("Sheet1", "B21", "A win/loss sparkline with negative points highlighted.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A21"}, Range: []string{"Sheet3!A3:J3"}, Type: "win_loss", @@ -151,7 +154,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B23", "A left to right column (the default).")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A23"}, Range: []string{"Sheet3!A4:J4"}, Type: "column", @@ -159,7 +162,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B24", "A right to left column.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A24"}, Range: []string{"Sheet3!A4:J4"}, Type: "column", @@ -168,7 +171,7 @@ func TestAddSparkline(t *testing.T) { })) assert.NoError(t, f.SetCellValue("Sheet1", "B25", "Sparkline and text in one cell.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A25"}, Range: []string{"Sheet3!A4:J4"}, Type: "column", @@ -177,34 +180,34 @@ func TestAddSparkline(t *testing.T) { assert.NoError(t, f.SetCellValue("Sheet1", "A25", "Growth")) assert.NoError(t, f.SetCellValue("Sheet1", "B27", "A grouped sparkline. Changes are applied to all three.")) - assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A27", "A28", "A29"}, Range: []string{"Sheet3!A5:J5", "Sheet3!A6:J6", "Sheet3!A7:J7"}, Markers: true, })) // Sheet2 sections - assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOptions{ Location: []string{"F3"}, Range: []string{"Sheet2!A3:E3"}, Type: "win_loss", Negative: true, })) - assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOptions{ Location: []string{"F1"}, Range: []string{"Sheet2!A1:E1"}, Markers: true, })) - assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOptions{ Location: []string{"F2"}, Range: []string{"Sheet2!A2:E2"}, Type: "column", Style: 12, })) - assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOption{ + assert.NoError(t, f.AddSparkline("Sheet2", &SparklineOptions{ Location: []string{"F3"}, Range: []string{"Sheet2!A3:E3"}, Type: "win_loss", @@ -215,39 +218,39 @@ func TestAddSparkline(t *testing.T) { assert.NoError(t, f.SaveAs(filepath.Join("test", "TestAddSparkline.xlsx"))) // Test error exceptions - assert.EqualError(t, f.AddSparkline("SheetN", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("SheetN", &SparklineOptions{ Location: []string{"F3"}, Range: []string{"Sheet2!A3:E3"}, }), "sheet SheetN does not exist") assert.EqualError(t, f.AddSparkline("Sheet1", nil), ErrParameterRequired.Error()) - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Range: []string{"Sheet2!A3:E3"}, }), ErrSparklineLocation.Error()) - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"F3"}, }), ErrSparklineRange.Error()) - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"F2", "F3"}, Range: []string{"Sheet2!A3:E3"}, }), ErrSparkline.Error()) - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"F3"}, Range: []string{"Sheet2!A3:E3"}, Type: "unknown_type", }), ErrSparklineType.Error()) - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"F3"}, Range: []string{"Sheet2!A3:E3"}, Style: -1, }), ErrSparklineStyle.Error()) - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"F3"}, Range: []string{"Sheet2!A3:E3"}, Style: -1, @@ -265,7 +268,7 @@ func TestAddSparkline(t *testing.T) { ` - assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOption{ + assert.EqualError(t, f.AddSparkline("Sheet1", &SparklineOptions{ Location: []string{"A2"}, Range: []string{"Sheet3!A1:J1"}, }), "XML syntax error on line 6: element closed by ") -- cgit v1.2.1