Skip to content

Commit 79741dd

Browse files
zeripathzeripath
committed
Slightly simplify getting the readme file and add some tests. Ensure that i18n also
works for docs/ etc. Signed-off-by: Andrew Thornton <[email protected]>
1 parent 82dc871 commit 79741dd

File tree

4 files changed

+158
-89
lines changed

4 files changed

+158
-89
lines changed

‎modules/markup/renderer.go

+23-4
Original file line numberDiff line numberDiff line change
@@ -313,15 +313,34 @@ func IsMarkupFile(name, markup string) bool {
313313
// based on its name. If an extension is provided, it will strictly
314314
// match that extension.
315315
// Note that the '.' should be provided in ext, e.g ".md"
316-
func IsReadmeFile(name string, ext ...string) bool {
316+
func IsReadmeFile(name string) bool {
317317
name = strings.ToLower(name)
318-
if len(ext) > 0 {
319-
return name == "readme"+ext[0]
320-
}
321318
if len(name) < 6 {
322319
return false
323320
} else if len(name) == 6 {
324321
return name == "readme"
325322
}
326323
return name[:7] == "readme."
327324
}
325+
326+
// IsReadmeFileExtension reports whether name looks like a README file
327+
// based on its name. If an extension is provided, it will strictly
328+
// match that extension.
329+
// Note that the '.' should be provided in ext, e.g ".md"
330+
func IsReadmeFileExtension(name string, ext ...string) (int, bool) {
331+
if len(name) < 6 || name[:6] != "readme" {
332+
return 0, false
333+
}
334+
335+
for i, extension := range ext {
336+
if name[6:] == extension {
337+
return i, true
338+
}
339+
}
340+
341+
if name[6] == '.' {
342+
return len(ext), true
343+
}
344+
345+
return 0, false
346+
}

‎modules/markup/renderer_test.go

+39-16
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,47 @@ func TestMisc_IsReadmeFile(t *testing.T) {
4040
assert.False(t, IsReadmeFile(testCase))
4141
}
4242

43-
trueTestCasesStrict := [][]string{
44-
{"readme", ""},
45-
{"readme.md", ".md"},
46-
{"readme.txt", ".txt"},
47-
}
48-
falseTestCasesStrict := [][]string{
49-
{"readme", ".md"},
50-
{"readme.md", ""},
51-
{"readme.md", ".txt"},
52-
{"readme.md", "md"},
53-
{"readmee.md", ".md"},
54-
{"readme.i18n.md", ".md"},
43+
type extensionTestcase struct {
44+
name string
45+
expected bool
46+
idx int
5547
}
5648

57-
for _, testCase := range trueTestCasesStrict {
58-
assert.True(t, IsReadmeFile(testCase[0], testCase[1]))
49+
exts := []string{".md", ".txt", ""}
50+
testCasesExtensions := []extensionTestcase{
51+
{
52+
name: "readme",
53+
expected: true,
54+
idx: 2,
55+
},
56+
{
57+
name: "readme.md",
58+
expected: true,
59+
idx: 0,
60+
},
61+
{
62+
name: "readme.txt",
63+
expected: true,
64+
idx: 1,
65+
},
66+
{
67+
name: "readme.doc",
68+
expected: true,
69+
idx: 3,
70+
},
71+
{
72+
name: "readmee.md",
73+
},
74+
{
75+
name: "readme..",
76+
expected: true,
77+
idx: 3,
78+
},
5979
}
60-
for _, testCase := range falseTestCasesStrict {
61-
assert.False(t, IsReadmeFile(testCase[0], testCase[1]))
80+
81+
for _, testCase := range testCasesExtensions {
82+
idx, ok := IsReadmeFileExtension(testCase.name, exts...)
83+
assert.Equal(t, testCase.expected, ok)
84+
assert.Equal(t, testCase.idx, idx)
6285
}
6386
}

‎routers/web/repo/view.go

+33-69
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func linesBytesCount(s []byte) int {
6767
}
6868

6969
// FIXME: There has to be a more efficient way of doing this
70-
func getReadmeFileFromPath(commit *git.Commit, treePath string) (*namedBlob, error) {
70+
func getReadmeFileFromPath(ctx *context.Context, commit *git.Commit, treePath string) (*namedBlob, error) {
7171
tree, err := commit.SubTree(treePath)
7272
if err != nil {
7373
return nil, err
@@ -78,50 +78,33 @@ func getReadmeFileFromPath(commit *git.Commit, treePath string) (*namedBlob, err
7878
return nil, err
7979
}
8080

81-
var readmeFiles [4]*namedBlob
82-
exts := []string{".md", ".txt", ""} // sorted by priority
81+
// Create a list of extensions in priority order
82+
// 1. Markdown files - with and without localisation - e.g. README.en-us.md or README.md
83+
// 2. Txt files - e.g. README.txt
84+
// 3. No extension - e.g. README
85+
exts := append(localizedExtensions(".md", ctx.Language()), ".txt", "") // sorted by priority
86+
extCount := len(exts)
87+
readmeFiles := make([]*namedBlob, extCount+1)
8388
for _, entry := range entries {
8489
if entry.IsDir() {
8590
continue
8691
}
87-
for i, ext := range exts {
88-
if markup.IsReadmeFile(entry.Name(), ext) {
89-
if readmeFiles[i] == nil || base.NaturalSortLess(readmeFiles[i].name, entry.Blob().Name()) {
90-
name := entry.Name()
91-
isSymlink := entry.IsLink()
92-
target := entry
93-
if isSymlink {
94-
target, err = entry.FollowLinks()
95-
if err != nil && !git.IsErrBadLink(err) {
96-
return nil, err
97-
}
98-
}
99-
if target != nil && (target.IsExecutable() || target.IsRegular()) {
100-
readmeFiles[i] = &namedBlob{
101-
name,
102-
isSymlink,
103-
target.Blob(),
104-
}
105-
}
106-
}
107-
}
108-
}
109-
110-
if markup.IsReadmeFile(entry.Name()) {
111-
if readmeFiles[3] == nil || base.NaturalSortLess(readmeFiles[3].name, entry.Blob().Name()) {
92+
if i, ok := markup.IsReadmeFileExtension(entry.Name(), exts...); ok {
93+
if readmeFiles[i] == nil || base.NaturalSortLess(readmeFiles[i].name, entry.Blob().Name()) {
11294
name := entry.Name()
11395
isSymlink := entry.IsLink()
96+
target := entry
11497
if isSymlink {
115-
entry, err = entry.FollowLinks()
98+
target, err = entry.FollowLinks()
11699
if err != nil && !git.IsErrBadLink(err) {
117100
return nil, err
118101
}
119102
}
120-
if entry != nil && (entry.IsExecutable() || entry.IsRegular()) {
121-
readmeFiles[3] = &namedBlob{
103+
if target != nil && (target.IsExecutable() || target.IsRegular()) {
104+
readmeFiles[i] = &namedBlob{
122105
name,
123106
isSymlink,
124-
entry.Blob(),
107+
target.Blob(),
125108
}
126109
}
127110
}
@@ -161,8 +144,11 @@ func renderDirectory(ctx *context.Context, treeLink string) {
161144
renderReadmeFile(ctx, readmeFile, readmeTreelink)
162145
}
163146

164-
// Note: This will always return lower-case strings
165-
func localizedExtensions(ext string, languageCode string) (localizedExts []string) {
147+
// localizedExtensions prepends the provided language code with and without a
148+
// regional identifier to the provided extenstion.
149+
// Note: the language code will always be lower-cased, if a region is present it must be separated with a `-`
150+
// Note: ext should be prefixed with a `.`
151+
func localizedExtensions(ext, languageCode string) (localizedExts []string) {
166152
if len(languageCode) < 1 {
167153
return []string{ext}
168154
}
@@ -181,14 +167,15 @@ func localizedExtensions(ext string, languageCode string) (localizedExts []strin
181167
}
182168

183169
func findReadmeFile(ctx *context.Context, entries git.Entries, treeLink string) (*namedBlob, string) {
184-
// 3 kinds of extensions in exts[] in order
185-
// the last one is for a readme that doesn't
186-
// strictly match an extension
170+
// Create a list of extensions in priority order
171+
// 1. Markdown files - with and without localisation - e.g. README.en-us.md or README.md
172+
// 2. Txt files - e.g. README.txt
173+
// 3. No extension - e.g. README
187174
exts := append(localizedExtensions(".md", ctx.Language()), ".txt", "") // sorted by priority
188175
extCount := len(exts)
189176
readmeFiles := make([]*namedBlob, extCount+1)
190-
docsEntries := make([]*git.TreeEntry, extCount)
191177

178+
docsEntries := make([]*git.TreeEntry, 3) // (one of docs/, .gitea/ or .github/)
192179
for _, entry := range entries {
193180
if entry.IsDir() {
194181
lowerName := strings.ToLower(entry.Name())
@@ -209,47 +196,24 @@ func findReadmeFile(ctx *context.Context, entries git.Entries, treeLink string)
209196
continue
210197
}
211198

212-
for i, ext := range exts {
213-
if markup.IsReadmeFile(entry.Name(), ext) {
214-
log.Debug("%s", entry.Name())
215-
name := entry.Name()
216-
isSymlink := entry.IsLink()
217-
target := entry
218-
if isSymlink {
219-
var err error
220-
target, err = entry.FollowLinks()
221-
if err != nil && !git.IsErrBadLink(err) {
222-
ctx.ServerError("FollowLinks", err)
223-
return nil, ""
224-
}
225-
}
226-
log.Debug("%t", target == nil)
227-
if target != nil && (target.IsExecutable() || target.IsRegular()) {
228-
readmeFiles[i] = &namedBlob{
229-
name,
230-
isSymlink,
231-
target.Blob(),
232-
}
233-
}
234-
}
235-
}
236-
237-
if markup.IsReadmeFile(entry.Name()) {
199+
if i, ok := markup.IsReadmeFileExtension(entry.Name(), exts...); ok {
200+
log.Debug("Potential readme file: %s", entry.Name())
238201
name := entry.Name()
239202
isSymlink := entry.IsLink()
203+
target := entry
240204
if isSymlink {
241205
var err error
242-
entry, err = entry.FollowLinks()
206+
target, err = entry.FollowLinks()
243207
if err != nil && !git.IsErrBadLink(err) {
244208
ctx.ServerError("FollowLinks", err)
245209
return nil, ""
246210
}
247211
}
248-
if entry != nil && (entry.IsExecutable() || entry.IsRegular()) {
249-
readmeFiles[extCount] = &namedBlob{
212+
if target != nil && (target.IsExecutable() || target.IsRegular()) {
213+
readmeFiles[i] = &namedBlob{
250214
name,
251215
isSymlink,
252-
entry.Blob(),
216+
target.Blob(),
253217
}
254218
}
255219
}
@@ -270,7 +234,7 @@ func findReadmeFile(ctx *context.Context, entries git.Entries, treeLink string)
270234
continue
271235
}
272236
var err error
273-
readmeFile, err = getReadmeFileFromPath(ctx.Repo.Commit, entry.GetSubJumpablePathName())
237+
readmeFile, err = getReadmeFileFromPath(ctx, ctx.Repo.Commit, entry.GetSubJumpablePathName())
274238
if err != nil {
275239
ctx.ServerError("getReadmeFileFromPath", err)
276240
return nil, ""

‎routers/web/repo/view_test.go

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Copyright 2017 The Gitea Authors. All rights reserved.
2+
// Copyright 2014 The Gogs Authors. All rights reserved.
3+
// Use of this source code is governed by a MIT-style
4+
// license that can be found in the LICENSE file.
5+
6+
package repo
7+
8+
import (
9+
"reflect"
10+
"testing"
11+
)
12+
13+
func Test_localizedExtensions(t *testing.T) {
14+
tests := []struct {
15+
name string
16+
ext string
17+
languageCode string
18+
wantLocalizedExts []string
19+
}{
20+
{
21+
name: "empty language",
22+
ext: ".md",
23+
wantLocalizedExts: []string{".md"},
24+
},
25+
{
26+
name: "No region - lowercase",
27+
languageCode: "en",
28+
ext: ".csv",
29+
wantLocalizedExts: []string{".en.csv", ".csv"},
30+
},
31+
{
32+
name: "No region - uppercase",
33+
languageCode: "FR",
34+
ext: ".txt",
35+
wantLocalizedExts: []string{".fr.txt", ".txt"},
36+
},
37+
{
38+
name: "With region - lowercase",
39+
languageCode: "en-us",
40+
ext: ".md",
41+
wantLocalizedExts: []string{".en-us.md", ".en_us.md", ".en.md", ".md"},
42+
},
43+
{
44+
name: "With region - uppercase",
45+
languageCode: "en-CA",
46+
ext: ".MD",
47+
wantLocalizedExts: []string{".en-ca.MD", ".en_ca.MD", ".en.MD", ".MD"},
48+
},
49+
{
50+
name: "With region - all uppercase",
51+
languageCode: "ZH-TW",
52+
ext: ".md",
53+
wantLocalizedExts: []string{".zh-tw.md", ".zh_tw.md", ".zh.md", ".md"},
54+
},
55+
}
56+
for _, tt := range tests {
57+
t.Run(tt.name, func(t *testing.T) {
58+
if gotLocalizedExts := localizedExtensions(tt.ext, tt.languageCode); !reflect.DeepEqual(gotLocalizedExts, tt.wantLocalizedExts) {
59+
t.Errorf("localizedExtensions() = %v, want %v", gotLocalizedExts, tt.wantLocalizedExts)
60+
}
61+
})
62+
}
63+
}

0 commit comments

Comments
 (0)