Skip to content

Commit 4e7b067

Browse files
KN4CK3RKN4CK3R
authored
Extract and display readme and comments for Composer packages (go-gitea#30927)
Related go-gitea#30075 CC @thojo0 Example with rendered readme: ![grafik](https://github.com/go-gitea/gitea/assets/1666336/3516fef5-2631-40fd-8841-5d9894ec8904)
1 parent fa82a8a commit 4e7b067

File tree

3 files changed

+90
-26
lines changed

3 files changed

+90
-26
lines changed

‎modules/packages/composer/metadata.go‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ package composer
66
import (
77
"archive/zip"
88
"io"
9+
"path"
910
"regexp"
1011
"strings"
1112

@@ -36,10 +37,14 @@ type Package struct {
3637
Metadata *Metadata
3738
}
3839

40+
// https://getcomposer.org/doc/04-schema.md
41+
3942
// Metadata represents the metadata of a Composer package
4043
type Metadata struct {
4144
Description string `json:"description,omitempty"`
45+
Readme string `json:"readme,omitempty"`
4246
Keywords []string `json:"keywords,omitempty"`
47+
Comments Comments `json:"_comments,omitempty"`
4348
Homepage string `json:"homepage,omitempty"`
4449
License Licenses `json:"license,omitempty"`
4550
Authors []Author `json:"authors,omitempty"`
@@ -74,6 +79,28 @@ func (l *Licenses) UnmarshalJSON(data []byte) error {
7479
return nil
7580
}
7681

82+
// Comments represents the comments of a Composer package
83+
type Comments []string
84+
85+
// UnmarshalJSON reads from a string or array
86+
func (c *Comments) UnmarshalJSON(data []byte) error {
87+
switch data[0] {
88+
case '"':
89+
var value string
90+
if err := json.Unmarshal(data, &value); err != nil {
91+
return err
92+
}
93+
*c = Comments{value}
94+
case '[':
95+
values := make([]string, 0, 5)
96+
if err := json.Unmarshal(data, &values); err != nil {
97+
return err
98+
}
99+
*c = Comments(values)
100+
}
101+
return nil
102+
}
103+
77104
// Author represents an author
78105
type Author struct {
79106
Name string `json:"name,omitempty"`
@@ -101,14 +128,14 @@ func ParsePackage(r io.ReaderAt, size int64) (*Package, error) {
101128
}
102129
defer f.Close()
103130

104-
return ParseComposerFile(f)
131+
return ParseComposerFile(archive, path.Dir(file.Name), f)
105132
}
106133
}
107134
return nil, ErrMissingComposerFile
108135
}
109136

110137
// ParseComposerFile parses a composer.json file to retrieve the metadata of a Composer package
111-
func ParseComposerFile(r io.Reader) (*Package, error) {
138+
func ParseComposerFile(archive *zip.Reader, pathPrefix string, r io.Reader) (*Package, error) {
112139
var cj struct {
113140
Name string `json:"name"`
114141
Version string `json:"version"`
@@ -137,6 +164,19 @@ func ParseComposerFile(r io.Reader) (*Package, error) {
137164
cj.Type = "library"
138165
}
139166

167+
if cj.Readme == "" {
168+
cj.Readme = "README.md"
169+
}
170+
f, err := archive.Open(path.Join(pathPrefix, cj.Readme))
171+
if err == nil {
172+
// 10kb limit for readme content
173+
buf, _ := io.ReadAll(io.LimitReader(f, 10*1024))
174+
cj.Readme = string(buf)
175+
_ = f.Close()
176+
} else {
177+
cj.Readme = ""
178+
}
179+
140180
return &Package{
141181
Name: cj.Name,
142182
Version: cj.Version,

‎modules/packages/composer/metadata_test.go‎

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ import (
1717
const (
1818
name = "gitea/composer-package"
1919
description = "Package Description"
20+
readme = "Package Readme"
21+
comments = "Package Comment"
2022
packageType = "composer-plugin"
2123
author = "Gitea Authors"
2224
email = "[email protected]"
@@ -41,7 +43,8 @@ const composerContent = `{
4143
},
4244
"require": {
4345
"php": ">=7.2 || ^8.0"
44-
}
46+
},
47+
"_comments": "` + comments + `"
4548
}`
4649

4750
func TestLicenseUnmarshal(t *testing.T) {
@@ -54,70 +57,91 @@ func TestLicenseUnmarshal(t *testing.T) {
5457
assert.Equal(t, "MIT", l[0])
5558
}
5659

60+
func TestCommentsUnmarshal(t *testing.T) {
61+
var c Comments
62+
assert.NoError(t, json.NewDecoder(strings.NewReader(`["comment"]`)).Decode(&c))
63+
assert.Len(t, c, 1)
64+
assert.Equal(t, "comment", c[0])
65+
assert.NoError(t, json.NewDecoder(strings.NewReader(`"comment"`)).Decode(&c))
66+
assert.Len(t, c, 1)
67+
assert.Equal(t, "comment", c[0])
68+
}
69+
5770
func TestParsePackage(t *testing.T) {
58-
createArchive := func(name, content string) []byte {
71+
createArchive := func(files map[string]string) []byte {
5972
var buf bytes.Buffer
6073
archive := zip.NewWriter(&buf)
61-
w, _ := archive.Create(name)
62-
w.Write([]byte(content))
74+
for name, content := range files {
75+
w, _ := archive.Create(name)
76+
w.Write([]byte(content))
77+
}
6378
archive.Close()
6479
return buf.Bytes()
6580
}
6681

6782
t.Run("MissingComposerFile", func(t *testing.T) {
68-
data := createArchive("dummy.txt", "")
83+
data := createArchive(map[string]string{"dummy.txt": ""})
6984

7085
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
7186
assert.Nil(t, cp)
7287
assert.ErrorIs(t, err, ErrMissingComposerFile)
7388
})
7489

7590
t.Run("MissingComposerFileInRoot", func(t *testing.T) {
76-
data := createArchive("sub/sub/composer.json", "")
91+
data := createArchive(map[string]string{"sub/sub/composer.json": ""})
7792

7893
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
7994
assert.Nil(t, cp)
8095
assert.ErrorIs(t, err, ErrMissingComposerFile)
8196
})
8297

8398
t.Run("InvalidComposerFile", func(t *testing.T) {
84-
data := createArchive("composer.json", "")
99+
data := createArchive(map[string]string{"composer.json": ""})
85100

86101
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
87102
assert.Nil(t, cp)
88103
assert.Error(t, err)
89104
})
90105

91-
t.Run("Valid", func(t *testing.T) {
92-
data := createArchive("composer.json", composerContent)
106+
t.Run("InvalidPackageName", func(t *testing.T) {
107+
data := createArchive(map[string]string{"composer.json": "{}"})
93108

94109
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
95-
assert.NoError(t, err)
96-
assert.NotNil(t, cp)
97-
})
98-
}
99-
100-
func TestParseComposerFile(t *testing.T) {
101-
t.Run("InvalidPackageName", func(t *testing.T) {
102-
cp, err := ParseComposerFile(strings.NewReader(`{}`))
103110
assert.Nil(t, cp)
104111
assert.ErrorIs(t, err, ErrInvalidName)
105112
})
106113

107114
t.Run("InvalidPackageVersion", func(t *testing.T) {
108-
cp, err := ParseComposerFile(strings.NewReader(`{"name": "gitea/composer-package", "version": "1.a.3"}`))
115+
data := createArchive(map[string]string{"composer.json": `{"name": "gitea/composer-package", "version": "1.a.3"}`})
116+
117+
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
109118
assert.Nil(t, cp)
110119
assert.ErrorIs(t, err, ErrInvalidVersion)
111120
})
112121

122+
t.Run("InvalidReadmePath", func(t *testing.T) {
123+
data := createArchive(map[string]string{"composer.json": `{"name": "gitea/composer-package", "readme": "sub/README.md"}`})
124+
125+
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
126+
assert.NoError(t, err)
127+
assert.NotNil(t, cp)
128+
129+
assert.Empty(t, cp.Metadata.Readme)
130+
})
131+
113132
t.Run("Valid", func(t *testing.T) {
114-
cp, err := ParseComposerFile(strings.NewReader(composerContent))
133+
data := createArchive(map[string]string{"composer.json": composerContent, "README.md": readme})
134+
135+
cp, err := ParsePackage(bytes.NewReader(data), int64(len(data)))
115136
assert.NoError(t, err)
116137
assert.NotNil(t, cp)
117138

118139
assert.Equal(t, name, cp.Name)
119140
assert.Empty(t, cp.Version)
120141
assert.Equal(t, description, cp.Metadata.Description)
142+
assert.Equal(t, readme, cp.Metadata.Readme)
143+
assert.Len(t, cp.Metadata.Comments, 1)
144+
assert.Equal(t, comments, cp.Metadata.Comments[0])
121145
assert.Len(t, cp.Metadata.Authors, 1)
122146
assert.Equal(t, author, cp.Metadata.Authors[0].Name)
123147
assert.Equal(t, email, cp.Metadata.Authors[0].Email)

‎templates/package/content/composer.tmpl‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222
</div>
2323
</div>
2424

25-
{{if .PackageDescriptor.Metadata.Description}}
25+
{{if or .PackageDescriptor.Metadata.Description .PackageDescriptor.Metadata.Comments}}
2626
<h4 class="ui top attached header">{{ctx.Locale.Tr "packages.about"}}</h4>
27-
<div class="ui attached segment">
28-
{{.PackageDescriptor.Metadata.Description}}
29-
</div>
27+
{{if .PackageDescriptor.Metadata.Description}}<div class="ui attached segment">{{.PackageDescriptor.Metadata.Description}}</div>{{end}}
28+
{{if .PackageDescriptor.Metadata.Readme}}<div class="ui attached segment markup markdown">{{RenderMarkdownToHtml $.Context .PackageDescriptor.Metadata.Readme}}</div>{{end}}
29+
{{if .PackageDescriptor.Metadata.Comments}}<div class="ui attached segment">{{StringUtils.Join .PackageDescriptor.Metadata.Comments " "}}</div>{{end}}
3030
{{end}}
3131

3232
{{if or .PackageDescriptor.Metadata.Require .PackageDescriptor.Metadata.RequireDev}}
@@ -39,7 +39,7 @@
3939
</div>
4040
{{end}}
4141

42-
{{if or .PackageDescriptor.Metadata.Keywords}}
42+
{{if .PackageDescriptor.Metadata.Keywords}}
4343
<h4 class="ui top attached header">{{ctx.Locale.Tr "packages.keywords"}}</h4>
4444
<div class="ui attached segment">
4545
{{range .PackageDescriptor.Metadata.Keywords}}

0 commit comments

Comments
 (0)