Skip to content

Commit 61be51e

Browse files
authored
Refactor markup package (#32399)
To make the markup package easier to maintain: 1. Split some go files into small files 2. Use a shared util.NopCloser, remove duplicate code 3. Remove unused functions
1 parent af28ce5 commit 61be51e

19 files changed

+1154
-1087
lines changed

Diff for: modules/gitrepo/gitrepo.go

+3-6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111

1212
"code.gitea.io/gitea/modules/git"
1313
"code.gitea.io/gitea/modules/setting"
14+
"code.gitea.io/gitea/modules/util"
1415
)
1516

1617
type Repository interface {
@@ -59,15 +60,11 @@ func repositoryFromContext(ctx context.Context, repo Repository) *git.Repository
5960
return nil
6061
}
6162

62-
type nopCloser func()
63-
64-
func (nopCloser) Close() error { return nil }
65-
6663
// RepositoryFromContextOrOpen attempts to get the repository from the context or just opens it
6764
func RepositoryFromContextOrOpen(ctx context.Context, repo Repository) (*git.Repository, io.Closer, error) {
6865
gitRepo := repositoryFromContext(ctx, repo)
6966
if gitRepo != nil {
70-
return gitRepo, nopCloser(nil), nil
67+
return gitRepo, util.NopCloser{}, nil
7168
}
7269

7370
gitRepo, err := OpenRepository(ctx, repo)
@@ -95,7 +92,7 @@ func repositoryFromContextPath(ctx context.Context, path string) *git.Repository
9592
func RepositoryFromContextOrOpenPath(ctx context.Context, path string) (*git.Repository, io.Closer, error) {
9693
gitRepo := repositoryFromContextPath(ctx, path)
9794
if gitRepo != nil {
98-
return gitRepo, nopCloser(nil), nil
95+
return gitRepo, util.NopCloser{}, nil
9996
}
10097

10198
gitRepo, err := git.OpenRepository(ctx, path)

Diff for: modules/log/event_writer_console.go

+4-9
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
package log
55

66
import (
7-
"io"
87
"os"
8+
9+
"code.gitea.io/gitea/modules/util"
910
)
1011

1112
type WriterConsoleOption struct {
@@ -18,19 +19,13 @@ type eventWriterConsole struct {
1819

1920
var _ EventWriter = (*eventWriterConsole)(nil)
2021

21-
type nopCloser struct {
22-
io.Writer
23-
}
24-
25-
func (nopCloser) Close() error { return nil }
26-
2722
func NewEventWriterConsole(name string, mode WriterMode) EventWriter {
2823
w := &eventWriterConsole{EventWriterBaseImpl: NewEventWriterBase(name, "console", mode)}
2924
opt := mode.WriterOption.(WriterConsoleOption)
3025
if opt.Stderr {
31-
w.OutputWriteCloser = nopCloser{os.Stderr}
26+
w.OutputWriteCloser = util.NopCloser{Writer: os.Stderr}
3227
} else {
33-
w.OutputWriteCloser = nopCloser{os.Stdout}
28+
w.OutputWriteCloser = util.NopCloser{Writer: os.Stdout}
3429
}
3530
return w
3631
}

Diff for: modules/log/event_writer_file.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ package log
66
import (
77
"io"
88

9+
"code.gitea.io/gitea/modules/util"
910
"code.gitea.io/gitea/modules/util/rotatingfilewriter"
1011
)
1112

@@ -42,7 +43,7 @@ func NewEventWriterFile(name string, mode WriterMode) EventWriter {
4243
// if the log file can't be opened, what should it do? panic/exit? ignore logs? fallback to stderr?
4344
// it seems that "fallback to stderr" is slightly better than others ....
4445
FallbackErrorf("unable to open log file %q: %v", opt.FileName, err)
45-
w.fileWriter = nopCloser{Writer: LoggerToWriter(FallbackErrorf)}
46+
w.fileWriter = util.NopCloser{Writer: LoggerToWriter(FallbackErrorf)}
4647
}
4748
w.OutputWriteCloser = w.fileWriter
4849
return w

0 commit comments

Comments
 (0)