Update CI, refactor code & use newest go version

Dadido3 · Dadido3 · commit 2444ead53009 · 2022-11-03T12:34:13.000+01:00
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -19,13 +19,26 @@ jobs:
 
     steps:
 
-    - uses: actions/checkout@v2
-
-    - uses: wangyoucao577/go-release-action@master
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        goos: ${{ matrix.goos }}
-        goarch: ${{ matrix.goarch }}
-        goversion: "https://golang.org/dl/go1.17.linux-amd64.tar.gz"
-        ldflags: -X 'main.versionString=${{ github.event.release.tag_name }}'
-        extra_files: LICENSE README.md
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ^1.19
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Build executable
+        run: go build -v -ldflags="-X 'main.versionString=${{ github.event.release.tag_name }}'" .
+        env:
+          GOARCH: ${{ matrix.goarch }}
+          GOOS: ${{ matrix.goos }}
+
+      - name: Create distribution archive
+        run: go run -v ./scripts/dist
+
+      - name: Upload binary to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file: dist/dist.zip
+          asset_name: batch-rename-${{ matrix.goos }}-${{ matrix.goarch }}.zip
+          overwrite: true
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -9,10 +9,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - name: Set up Go 1.x
+    - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: ^1.17
+        go-version: ^1.19
       id: go
 
     - name: Check out code into the Go module directory
diff --git a/.gitignore b/.gitignore
@@ -70,3 +70,4 @@ $RECYCLE.BIN/
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 
+/dist/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,11 @@
 {
     "cSpell.words": [
         "Dadido",
-        "Vogel"
+        "GOARCH",
+        "goversion",
+        "ldflags",
+        "svenstaro",
+        "Vogel",
+        "wangyoucao"
     ]
 }
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 David Vogel
+Copyright (c) 2021-2022 David Vogel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/file-entry.go b/file-entry.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2021 David Vogel
+// Copyright (c) 2021-2022 David Vogel
 //
 // This software is released under the MIT License.
 // https://opensource.org/licenses/MIT
diff --git a/file-handling.go b/file-handling.go
@@ -0,0 +1,79 @@
+// Copyright (c) 2022 David Vogel
+//
+// This software is released under the MIT License.
+// https://opensource.org/licenses/MIT
+
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"log"
+	"os"
+	"strconv"
+	"strings"
+)
+
+// createEntriesFile creates a new file with all the fileEntries and returns its file path.
+func createEntriesFile(rootDir string, fileEntries []fileEntry) (filePath string, err error) {
+	// Create temporary file with paths.
+	file, err := os.CreateTemp(".", "*.batch-rename")
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	decimalWidth := getDecimalWidth(uint(len(fileEntries)))
+
+	for i, fileEntry := range fileEntries {
+		fmt.Fprintf(file, "%0"+fmt.Sprint(decimalWidth)+"d\t%s\n", i+1, fileEntry.originalPath)
+	}
+
+	if err := file.Close(); err != nil {
+		return "", err
+	}
+
+	return file.Name(), nil
+}
+
+// readEntriesFile reads the (edited) temporary file back and modifies the fileEntries with the new file paths.
+func readEntriesFile(filePath string, fileEntries []fileEntry) error {
+	file, err := os.Open(filePath)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		substrings := strings.SplitN(scanner.Text(), "\t", 2)
+		entry, err := strconv.ParseUint(substrings[0], 10, 64)
+		if err != nil {
+			return fmt.Errorf("failed to parse element number: %w", err)
+		}
+		if entry <= 0 || entry > uint64(len(fileEntries)) {
+			return fmt.Errorf("element number outside of valid range: Given %v, there are %v entries", entry, len(fileEntries))
+		}
+		fileEntries[entry-1].newPath = substrings[1]
+	}
+
+	if err := scanner.Err(); err != nil {
+		return fmt.Errorf("failed to scan file: %w", err)
+	}
+
+	return nil
+}
+
+// moveFiles renames the files according to the list of file entries.
+func moveFiles(fileEntries []fileEntry) error {
+	for _, fileEntry := range fileEntries {
+		if fileEntry.originalPath != fileEntry.newPath {
+			if err := os.Rename(fileEntry.originalPath, fileEntry.newPath); err != nil {
+				return err
+			}
+			log.Printf("Renamed %q to %q", fileEntry.originalPath, fileEntry.newPath)
+			fileEntry.originalPath = fileEntry.newPath
+		}
+	}
+
+	return nil
+}
diff --git a/go.mod b/go.mod
@@ -1,7 +1,10 @@
 module github.com/Dadido3/batch-rename
 
-go 1.17
+go 1.19
 
-require github.com/coreos/go-semver v0.3.0
+require (
+	github.com/coreos/go-semver v0.3.0
+	golang.org/x/exp v0.0.0-20221031165847-c99f073a8326
+)
 
 require gopkg.in/yaml.v2 v2.4.0 // indirect
diff --git a/go.sum b/go.sum
@@ -1,5 +1,7 @@
 github.com/coreos/go-semver v0.3.0 h1:wkHLiw0WNATZnSG7epLsujiMCgPAc9xhjJ4tgnAxmfM=
 github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
+golang.org/x/exp v0.0.0-20221031165847-c99f073a8326 h1:QfTh0HpN6hlw6D3vu8DAwC8pBIwikq0AI1evdm+FksE=
+golang.org/x/exp v0.0.0-20221031165847-c99f073a8326/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
diff --git a/main.go b/main.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2021 David Vogel
+// Copyright (c) 2021-2022 David Vogel
 //
 // This software is released under the MIT License.
 // https://opensource.org/licenses/MIT
@@ -7,79 +7,12 @@ package main
 
 import (
 	"bufio"
-	"fmt"
 	"io/fs"
 	"log"
 	"os"
 	"path/filepath"
-	"strconv"
-	"strings"
 )
 
-// createEntriesFile creates a new file with all the fileEntries and returns its file path.
-func createEntriesFile(rootDir string, fileEntries []fileEntry) (filePath string, err error) {
-	// Create temporary file with paths.
-	file, err := os.CreateTemp(".", "*.batch-rename")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	decimalWidth := getDecimalWidth(uint(len(fileEntries)))
-
-	for i, fileEntry := range fileEntries {
-		fmt.Fprintf(file, "%0"+fmt.Sprint(decimalWidth)+"d\t%s\n", i+1, fileEntry.originalPath)
-	}
-
-	if err := file.Close(); err != nil {
-		return "", err
-	}
-
-	return file.Name(), nil
-}
-
-// readEntriesFile reads the (edited) temporary file back and modifies the fileEntries with the new file paths.
-func readEntriesFile(filePath string, fileEntries []fileEntry) error {
-	file, err := os.Open(filePath)
-	if err != nil {
-		return err
-	}
-	defer file.Close()
-
-	scanner := bufio.NewScanner(file)
-	for scanner.Scan() {
-		substrings := strings.SplitN(scanner.Text(), "\t", 2)
-		entry, err := strconv.ParseUint(substrings[0], 10, 64)
-		if err != nil {
-			return fmt.Errorf("failed to parse element number: %w", err)
-		}
-		if entry <= 0 || entry > uint64(len(fileEntries)) {
-			return fmt.Errorf("element number outside of valid range: Given %v, there are %v entries", entry, len(fileEntries))
-		}
-		fileEntries[entry-1].newPath = substrings[1]
-	}
-
-	if err := scanner.Err(); err != nil {
-		return fmt.Errorf("failed to scan file: %w", err)
-	}
-
-	return nil
-}
-
-// moveFiles renames the files according to the list of file entries.
-func moveFiles(fileEntries []fileEntry) error {
-	for _, fileEntry := range fileEntries {
-		if fileEntry.originalPath != fileEntry.newPath {
-			if err := os.Rename(fileEntry.originalPath, fileEntry.newPath); err != nil {
-				return err
-			}
-			log.Printf("Renamed %q to %q", fileEntry.originalPath, fileEntry.newPath)
-			fileEntry.originalPath = fileEntry.newPath
-		}
-	}
-
-	return nil
-}
-
 func main() {
 	log.Printf("Started batch-rename v%v", version)
 
diff --git a/scripts/dist/compress.go b/scripts/dist/compress.go
@@ -0,0 +1,79 @@
+// Copyright (c) 2022 David Vogel
+//
+// This software is released under the MIT License.
+// https://opensource.org/licenses/MIT
+
+package main
+
+import (
+	"archive/zip"
+	"io"
+	"io/fs"
+	"log"
+	"os"
+	"path/filepath"
+
+	"golang.org/x/exp/slices"
+)
+
+// addPathToZip adds the given file or directory at srcPath to the zipWriter.
+//
+// The ignorePaths list is compared to the archive path (archive base path + relative path).
+func addPathToZip(zipWriter *zip.Writer, srcPath, archiveBasePath string, ignorePaths []string) error {
+	return filepath.WalkDir(srcPath, func(path string, d fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+
+		relPath, err := filepath.Rel(srcPath, path)
+		if err != nil {
+			return err
+		}
+		archivePath := filepath.Join(archiveBasePath, relPath)
+
+		// Skip if path is in ignore list.
+		// This applies to directories or files.
+		if slices.Contains(ignorePaths, archivePath) {
+			log.Printf("Skipped %q", archivePath)
+			if d.IsDir() {
+				return fs.SkipDir
+			}
+			return nil
+		}
+
+		// Ignore directories.
+		if d.IsDir() {
+			return nil
+		}
+
+		fileToZip, err := os.Open(path)
+		if err != nil {
+			return err
+		}
+		defer fileToZip.Close()
+
+		info, err := fileToZip.Stat()
+		if err != nil {
+			return err
+		}
+
+		header, err := zip.FileInfoHeader(info)
+		if err != nil {
+			return err
+		}
+
+		header.Name = archivePath
+		header.Method = zip.Deflate
+
+		writer, err := zipWriter.CreateHeader(header)
+		if err != nil {
+			return err
+		}
+
+		if _, err = io.Copy(writer, fileToZip); err != nil {
+			return err
+		}
+
+		return nil
+	})
+}
diff --git a/scripts/dist/main.go b/scripts/dist/main.go

Original file line number	Diff line number	Diff line change
`@@ -70,3 +70,4 @@ $RECYCLE.BIN/`
`70`	`70`
`71`	`71`	`# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)`
`72`	`72`
	`73`	`+/dist/`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,11 @@`
`1`	`1`	`{`
`2`	`2`	`"cSpell.words": [`
`3`	`3`	`"Dadido",`
`4`		`- "Vogel"`
	`4`	`+ "GOARCH",`
	`5`	`+ "goversion",`
	`6`	`+ "ldflags",`
	`7`	`+ "svenstaro",`
	`8`	`+ "Vogel",`
	`9`	`+ "wangyoucao"`
`5`	`10`	`]`
`6`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2021 David Vogel`
	`1`	`+// Copyright (c) 2021-2022 David Vogel`
`2`	`2`	`//`
`3`	`3`	`// This software is released under the MIT License.`
`4`	`4`	`// https://opensource.org/licenses/MIT`