• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

mlange-42 / modo / 12816549311

16 Jan 2025 07:54PM CUT coverage: 34.117% (-3.0%) from 37.068%
12816549311

Pull #46

github

web-flow
Merge bad20b0e7 into cd52159d3
Pull Request #46: Fix overwritten cross-refs for multi re-export

0 of 105 new or added lines in 3 files covered. (0.0%)

450 of 1319 relevant lines covered (34.12%)

2.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

60.0
/document/document.go
1
package document
2

3
import (
4
        "bytes"
5
        "encoding/json"
6
        "unicode"
7
)
8

9
const capitalFileMarker = "-"
10

11
var CaseSensitiveSystem = true
12

13
type Docs struct {
14
        Decl    *Package
15
        Version string
16
}
17

18
type Package struct {
19
        MemberKind
20
        MemberName
21
        *MemberSummary
22
        *MemberDescription
23
        Modules   []*Module
24
        Packages  []*Package
25
        Exports   []*PackageExport // Additional field for package re-exports
26
        Functions []*Function      // Additional field for package re-exports
27
        Structs   []*Struct        // Additional field for package re-exports
28
        Traits    []*Trait         // Additional field for package re-exports
29
}
30

31
func (p *Package) linkedCopy() *Package {
4✔
32
        return &Package{
4✔
33
                MemberName:        NewName(p.Name),
4✔
34
                MemberKind:        NewKind(p.Kind),
4✔
35
                MemberSummary:     p.MemberSummary,
4✔
36
                MemberDescription: p.MemberDescription,
4✔
37
                Exports:           p.Exports,
4✔
38
        }
4✔
39
}
4✔
40

41
type Module struct {
42
        MemberKind
43
        MemberName
44
        MemberSummary
45
        Description string
46
        Aliases     []*Alias
47
        Functions   []*Function
48
        Structs     []*Struct
49
        Traits      []*Trait
50
}
51

52
type Alias struct {
53
        MemberKind
54
        MemberName
55
        MemberSummary
56
        Description string
57
        Value       string
58
        Deprecated  string
59
}
60

61
type Struct struct {
62
        MemberKind
63
        MemberName
64
        MemberSummary
65
        Description  string
66
        Aliases      []*Alias
67
        Constraints  string
68
        Convention   string
69
        Deprecated   string
70
        Fields       []*Field
71
        Functions    []*Function
72
        Parameters   []*Parameter
73
        ParentTraits []string
74
        Signature    string
75
}
76

77
type Function struct {
78
        MemberKind
79
        MemberName
80
        MemberSummary
81
        Description          string
82
        Args                 []*Arg
83
        Overloads            []*Function
84
        Async                bool
85
        Constraints          string
86
        Deprecated           string
87
        IsDef                bool
88
        IsStatic             bool
89
        IsImplicitConversion bool
90
        Raises               bool
91
        RaisesDoc            string
92
        ReturnType           string
93
        ReturnsDoc           string
94
        Signature            string
95
        Parameters           []*Parameter
96
}
97

98
type Field struct {
99
        MemberKind
100
        MemberName
101
        MemberSummary
102
        Description string
103
        Type        string
104
}
105

106
type Trait struct {
107
        MemberKind
108
        MemberName
109
        MemberSummary
110
        Description  string
111
        Fields       []*Field
112
        Functions    []*Function
113
        ParentTraits []string
114
        Deprecated   string
115
}
116

117
type Arg struct {
118
        MemberKind
119
        MemberName
120
        Description string
121
        Convention  string
122
        Type        string
123
        PassingKind string
124
        Default     string
125
}
126

127
type Parameter struct {
128
        MemberKind
129
        MemberName
130
        Description string
131
        Type        string
132
        PassingKind string
133
        Default     string
134
}
135

136
func FromJson(data []byte) (*Docs, error) {
1✔
137
        reader := bytes.NewReader(data)
1✔
138
        dec := json.NewDecoder(reader)
1✔
139
        dec.DisallowUnknownFields()
1✔
140

1✔
141
        var docs Docs
1✔
142

1✔
143
        if err := dec.Decode(&docs); err != nil {
1✔
144
                return nil, err
×
145
        }
×
146

147
        cleanup(&docs)
1✔
148

1✔
149
        return &docs, nil
1✔
150
}
151

152
type Kinded interface {
153
        GetKind() string
154
}
155

156
type Named interface {
157
        GetName() string
158
        GetFileName() string
159
}
160

161
type Summarized interface {
162
        GetSummary() string
163
}
164

165
type MemberKind struct {
166
        Kind string
167
}
168

169
func NewKind(kind string) MemberKind {
38✔
170
        return MemberKind{Kind: kind}
38✔
171
}
38✔
172

173
func (k *MemberKind) GetKind() string {
×
174
        return k.Kind
×
175
}
×
176

177
type MemberName struct {
178
        Name string
179
}
180

181
func NewName(name string) MemberName {
51✔
182
        return MemberName{Name: name}
51✔
183
}
51✔
184

185
func (k *MemberName) GetName() string {
26✔
186
        return k.Name
26✔
187
}
26✔
188

189
func (k *MemberName) GetFileName() string {
6✔
190
        if CaseSensitiveSystem {
12✔
191
                return k.Name
6✔
192
        }
6✔
193
        if isCap(k.Name) {
×
194
                return k.Name + capitalFileMarker
×
195
        }
×
196
        return k.Name
×
197
}
198

199
type MemberSummary struct {
200
        Summary string
201
}
202

203
func NewSummary(summary string) *MemberSummary {
×
204
        return &MemberSummary{Summary: summary}
×
205
}
×
206

207
func (k *MemberSummary) GetSummary() string {
×
208
        return k.Summary
×
209
}
×
210

211
type MemberDescription struct {
212
        Description string
213
}
214

215
func NewDescription(description string) *MemberDescription {
4✔
216
        return &MemberDescription{Description: description}
4✔
217
}
4✔
218

219
func (k *MemberDescription) GetDescription() string {
×
220
        return k.Description
×
221
}
×
222

223
func isCap(s string) bool {
×
224
        if len(s) == 0 {
×
225
                return false
×
226
        }
×
227
        firstRune := []rune(s)[0]
×
228
        return unicode.IsUpper(firstRune)
×
229
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc