serv/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-27 06:03:51 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

add org readme to search with priority

Browse source 
This adds org-mode readmes to the extensions that are prioritized when
searching for readme. Org-mode readmes come after markdown readmes in
terms of priority and before txt readmes.

Closes #4073
This commit is contained in:
Beowulf 2024-06-16 12:28:07 +02:00
parent d6abb363f6
commit b03cc85f79
No known key found for this signature in database
GPG key ID: 44225F5F2792841D
2 changed files with 161 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
routers/web/repo/view.go
View file

@ -75,12 +75,13 @@ const (
// entries == ctx.Repo.Commit.SubTree(ctx.Repo.TreePath).ListEntries()
//
// FIXME: There has to be a more efficient way of doing this
func findReadmeFileInEntries(ctx *context.Context, entries []*git.TreeEntry, tryWellKnownDirs bool) (string, *git.TreeEntry, error) {
func FindReadmeFileInEntries(ctx *context.Context, entries []*git.TreeEntry, tryWellKnownDirs bool) (string, *git.TreeEntry, error) {
// Create a list of extensions in priority order
// 1. Markdown files - with and without localisation - e.g. README.en-us.md or README.md
// 2. Txt files - e.g. README.txt
// 3. No extension - e.g. README
exts := append(localizedExtensions(".md", ctx.Locale.Language()), ".txt", "") // sorted by priority
// 2. Org-Mode files - with and without localisation - e.g. README.en-us.org or README.org
// 3. Txt files - e.g. README.txt
// 4. No extension - e.g. README
exts := append(append(localizedExtensions(".md", ctx.Locale.Language()), localizedExtensions(".org", ctx.Locale.Language())...), ".txt", "") // sorted by priority
extCount := len(exts)
readmeFiles := make([]*git.TreeEntry, extCount+1)
@ -151,7 +152,7 @@ func findReadmeFileInEntries(ctx *context.Context, entries []*git.TreeEntry, try
return "", nil, err
}
subfolder, readmeFile, err := findReadmeFileInEntries(ctx, childEntries, false)
subfolder, readmeFile, err := FindReadmeFileInEntries(ctx, childEntries, false)
if err != nil && !git.IsErrNotExist(err) {
return "", nil, err
}
@ -175,7 +176,7 @@ func renderDirectory(ctx *context.Context) {
ctx.Data["Title"] = ctx.Tr("repo.file.title", ctx.Repo.Repository.Name+"/"+ctx.Repo.TreePath, ctx.Repo.RefName)
}
subfolder, readmeFile, err := findReadmeFileInEntries(ctx, entries, true)
subfolder, readmeFile, err := FindReadmeFileInEntries(ctx, entries, true)
if err != nil {
ctx.ServerError("findReadmeFileInEntries", err)
return

154
tests/integration/repo_view_test.go Normal file
View file

@ -0,0 +1,154 @@
// Copyright 2024 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package integration
import (
"fmt"
"net/url"
"strings"
"testing"
unit_model "code.gitea.io/gitea/models/unit"
"code.gitea.io/gitea/models/unittest"
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/routers/web/repo"
"code.gitea.io/gitea/services/context"
"code.gitea.io/gitea/services/contexttest"
files_service "code.gitea.io/gitea/services/repository/files"
"github.com/stretchr/testify/assert"
)
func createRepoAndGetContext(t *testing.T, files []string, deleteMdReadme bool) (*context.Context, func()) {
t.Helper()
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user1"})
size := len(files)
if deleteMdReadme {
size++
}
changeFiles := make([]*files_service.ChangeRepoFile, size)
for i, e := range files {
changeFiles[i] = &files_service.ChangeRepoFile{
Operation: "create",
TreePath: e,
ContentReader: strings.NewReader("test"),
}
}
if deleteMdReadme {
changeFiles[len(files)] = &files_service.ChangeRepoFile{
Operation: "delete",
TreePath: "README.md",
}
}
// README.md is already added by auto init
repo, _, f := CreateDeclarativeRepo(t, user, "readmetest", []unit_model.Type{unit_model.TypeCode}, nil, changeFiles)
ctx, _ := contexttest.MockContext(t, "user1/readmetest")
ctx.SetParams(":id", fmt.Sprint(repo.ID))
contexttest.LoadRepo(t, ctx, repo.ID)
contexttest.LoadRepoCommit(t, ctx)
return ctx, f
}
func TestRepoView_FindReadme(t *testing.T) {
t.Run("PrioOneLocalizedMdReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README.en.md", "README.en.org", "README.org", "README.txt", "README.tex"}, false)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README.en.md", file.Name())
})
})
t.Run("PrioTwoMdReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README.en.org", "README.org", "README.txt", "README.tex"}, false)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README.md", file.Name())
})
})
t.Run("PrioThreeLocalizedOrgReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README.en.org", "README.org", "README.txt", "README.tex"}, true)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README.en.org", file.Name())
})
})
t.Run("PrioFourOrgReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README.org", "README.txt", "README.tex"}, true)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README.org", file.Name())
})
})
t.Run("PrioFiveTxtReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README.txt", "README", "README.tex"}, true)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README.txt", file.Name())
})
})
t.Run("PrioSixWithoutExtensionReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README", "README.tex"}, true)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README", file.Name())
})
})
t.Run("PrioSevenAnyReadme", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{"README.tex"}, true)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Equal(t, "README.tex", file.Name())
})
})
t.Run("DoNotPickReadmeIfNonPresent", func(t *testing.T) {
onGiteaRun(t, func(t *testing.T, u *url.URL) {
ctx, f := createRepoAndGetContext(t, []string{}, true)
defer f()
tree, _ := ctx.Repo.Commit.SubTree(ctx.Repo.TreePath)
entries, _ := tree.ListEntries()
_, file, _ := repo.FindReadmeFileInEntries(ctx, entries, false)
assert.Nil(t, file)
})
})
}