Merge pull request #92 from devlights/add-workbook-mustsave

Add Workbook.{MustSave,MustSaveAs}

Author: devlights

README.md

@@ -48,7 +48,7 @@ func run() (int, string) {
 	// 1. Create new Goxcel instance.
 	excel, release := goxcel.MustNewGoxcel()
 
-	// must call goxcel's release function when function exited
+	// must call goxcel release function when function exited
 	// otherwise excel process was remained.
 	defer release()
 
@@ -62,7 +62,7 @@ func run() (int, string) {
 	// 3. Add Workbook
 	wb, wbRelease := wbs.MustAdd()
 
-	// call workbook's release funciton
+	// call workbook's release function
 	defer wbRelease()
 
 	// 4. Get Worksheet
@@ -78,10 +78,7 @@ func run() (int, string) {
 	log.Printf("SAVE FILE: %s\n", p)
 
 	// 7. Save
-	if err := wb.SaveAs(p); err != nil {
-		log.Println(err)
-		return 7, ""
-	}
+	wb.MustSaveAs(p)
 
 	// Workbook::SetSaved(true) and Workbook::Close() is automatically called when `defer wbReleaseFn()`.
 	// Excel::Quit() and Excel::Release() is automatically called when `defer release()`.

examples/must_methods/helloworld_use_mustmethods.go

@@ -34,7 +34,7 @@ func run() (int, string) {
 	// 1. Create new Goxcel instance.
 	g, goxcelReleaseFn := goxcel.MustNewGoxcel()
 
-	// must call goxcel's release function when function exited
+	// must call goxcel release function when function exited
 	// otherwise excel process was remained.
 	defer goxcelReleaseFn()
 
@@ -48,7 +48,7 @@ func run() (int, string) {
 	// 3. Add Workbook
 	wb, wbReleaseFn := wbs.MustAdd()
 
-	// call workbook's release funciton
+	// call workbook's release function
 	defer wbReleaseFn()
 
 	// 4. Get Worksheet
@@ -67,10 +67,7 @@ func run() (int, string) {
 	log.Printf("SAVE FILE: %s\n", p)
 
 	// 7. Save
-	if err := wb.SaveAs(p); err != nil {
-		log.Println(err)
-		return 7, ""
-	}
+	wb.MustSaveAs(p)
 
 	// Workbook::SetSaved(true) and Workbook::Close() is automatically called when `defer wbReleaseFn()`.
 	// Excel::Quit() and Excel::Release() is automatically called when `defer goxcelReleaseFn()`.

go.mod

@@ -5,7 +5,7 @@ go 1.20
 require (
 	github.com/go-ole/go-ole v1.3.0
 	github.com/skanehira/clipboard-image/v2 v2.0.0
-	golang.org/x/sync v0.3.0
+	golang.org/x/sync v0.6.0
 )
 
-require golang.org/x/sys v0.11.0 // indirect
+require golang.org/x/sys v0.18.0 // indirect

go.sum

@@ -4,6 +4,10 @@ github.com/skanehira/clipboard-image/v2 v2.0.0 h1:Kp+RNOgIlgzDkP3EskwuBnM0Fk4sc+
 github.com/skanehira/clipboard-image/v2 v2.0.0/go.mod h1:NXSYl4FJinIUFKJfeP1lGz8DIEUYjnEqwdMZ777S1E0=
 golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E=
 golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
+golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
+golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
 golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
+golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=

testutil/testutil.go

@@ -1,6 +1,8 @@
 package testutil
 
-import "time"
+import (
+	"time"
+)
 
 func Interval() {
 	time.Sleep(3 * time.Second)

workbook.go

@@ -96,10 +96,24 @@ func (w *Workbook) Save() error {
 	return err
 }
 
+func (w *Workbook) MustSave() {
+	err := w.Save()
+	if err != nil {
+		panic(err)
+	}
+}
+
 func (w *Workbook) SaveAs(filePath string) error {
 	return w.SaveAsWithFileFormat(filePath, constants.XlOpenXMLWorkbook)
 }
 
+func (w *Workbook) MustSaveAs(filePath string) {
+	err := w.SaveAs(filePath)
+	if err != nil {
+		panic(err)
+	}
+}
+
 func (w *Workbook) SaveAsWithFileFormat(filePath string, format constants.XlFileFormat) error {
 	_, err := oleutil.CallMethod(w.ComObject(), "SaveAs", filePath, int(format))
 	return err

workbook_test.go

@@ -8,6 +8,30 @@ import (
 	"github.com/devlights/goxcel/testutil"
 )
 
+func createExcelBook(xlsxPath string) {
+	var err error
+
+	if _, err = os.Stat(xlsxPath); !os.IsNotExist(err) {
+		err = os.Remove(xlsxPath)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	quit := MustInitGoxcel()
+	defer quit()
+
+	excel, release := MustNewGoxcel()
+	defer release()
+
+	excel.MustSilent(false)
+	wbs := excel.MustWorkbooks()
+	wb, wbRelease := wbs.MustAdd()
+	defer wbRelease()
+
+	wb.MustSaveAs(xlsxPath)
+}
+
 func TestWorkbook_MustMethods(t *testing.T) {
 	f := MustInitGoxcel()
 	defer f()
@@ -39,6 +63,10 @@ func TestWorkbook_Save(t *testing.T) {
 	testutil.Interval()
 	defer testutil.Interval()
 
+	userHomeDir, _ := os.UserHomeDir()
+	xlsxPath := filepath.Join(userHomeDir, "Book1.xlsx")
+	createExcelBook(xlsxPath)
+
 	g, r, err := NewGoxcel()
 
 	if err != nil {
@@ -55,8 +83,6 @@ func TestWorkbook_Save(t *testing.T) {
 		t.Error(err)
 	}
 
-	userHomeDir, _ := os.UserHomeDir()
-	xlsxPath := filepath.Join(userHomeDir, "Book1.xlsx")
 	wb, wbReleaseFn, _ := wbs.Open(xlsxPath)
 	defer wbReleaseFn()
 
@@ -76,6 +102,10 @@ func TestWorkbook_SaveAs(t *testing.T) {
 	testutil.Interval()
 	defer testutil.Interval()
 
+	userHomeDir, _ := os.UserHomeDir()
+	srcXlsxPath := filepath.Join(userHomeDir, "Book1.xlsx")
+	createExcelBook(srcXlsxPath)
+
 	g, r, err := NewGoxcel()
 
 	if err != nil {
@@ -92,8 +122,6 @@ func TestWorkbook_SaveAs(t *testing.T) {
 		t.Error(err)
 	}
 
-	userHomeDir, _ := os.UserHomeDir()
-	srcXlsxPath := filepath.Join(userHomeDir, "Book1.xlsx")
 	wb, wbReleaseFn, _ := wbs.Open(srcXlsxPath)
 	defer wbReleaseFn()