12775901286

Committed 14 Jan 2025 08:31PM CUT coverage: 34.058% (+0.2%) from 33.838%

Build # 12775901286

Build Type

Pull #36

github

Committed by

web-flow

Commit Message

Merge a0c741f43 into 2dc9d3121

Pull Request Pull Request #36: Add Hugo export format

Run Details

16 of 53 new or added lines in 7 files covered. (30.19%)

1 existing line in 1 file now uncovered.

282 of 828 relevant lines covered (34.06%)

2.1 hits per line

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

53.33

/document/document.go

package document

import (
        "bytes"
        "encoding/json"
        "unicode"
)

const capitalFileMarker = "-"

var CaseSensitiveSystem = true

type Docs struct {
        Decl    *Package
        Version string
}

type Package struct {
        MemberKind
        MemberName
        MemberSummary
        Description string
        Modules     []*Module
        Packages    []*Package
}

type Module struct {
        MemberKind
        MemberName
        MemberSummary
        Description string
        Aliases     []*Alias
        Functions   []*Function
        Structs     []*Struct
        Traits      []*Trait
}

type Alias struct {
        MemberKind
        MemberName
        MemberSummary
        Description string
        Value       string
        Deprecated  string
}

type Struct struct {
        MemberKind
        MemberName
        MemberSummary
        Description  string
        Aliases      []*Alias
        Constraints  string
        Convention   string
        Deprecated   string
        Fields       []*Field
        Functions    []*Function
        Parameters   []*Parameter
        ParentTraits []string
        Signature    string
}

type Function struct {
        MemberKind
        MemberName
        MemberSummary
        Description          string
        Args                 []*Arg
        Overloads            []*Function
        Async                bool
        Constraints          string
        Deprecated           string
        IsDef                bool
        IsStatic             bool
        IsImplicitConversion bool
        Raises               bool
        RaisesDoc            string
        ReturnType           string
        ReturnsDoc           string
        Signature            string
        Parameters           []*Parameter
}

type Field struct {
        MemberKind
        MemberName
        MemberSummary
        Description string
        Type        string
}

type Trait struct {
        MemberKind
        MemberName
        MemberSummary
        Description  string
        Fields       []*Field
        Functions    []*Function
        ParentTraits []string
        Deprecated   string
}

type Arg struct {
        MemberKind
        MemberName
        Description string
        Convention  string
        Type        string
        PassingKind string
        Default     string
}

type Parameter struct {
        MemberKind
        MemberName
        Description string
        Type        string
        PassingKind string
        Default     string
}

func FromJson(data []byte) (*Docs, error) {
        reader := bytes.NewReader(data)
        dec := json.NewDecoder(reader)
        dec.DisallowUnknownFields()

        var docs Docs

        if err := dec.Decode(&docs); err != nil {
                return nil, err
        }

        cleanup(&docs)

        return &docs, nil
}

type Kinded interface {
        GetKind() string
}

type Named interface {
        GetName() string
        GetFileName() string
}

type Summarized interface {
        GetSummary() string
}

type MemberKind struct {
        Kind string
}

func NewKind(kind string) MemberKind {
        return MemberKind{Kind: kind}
}

func (k *MemberKind) GetKind() string {
        return k.Kind
}

type MemberName struct {
        Name string
}

func NewName(name string) MemberName {
        return MemberName{Name: name}
}

func (k *MemberName) GetName() string {
        return k.Name
}

func (k *MemberName) GetFileName() string {
        if CaseSensitiveSystem {
                return k.Name
        }
        if isCap(k.Name) {
                return k.Name + capitalFileMarker
        }
        return k.Name
}

type MemberSummary struct {
        Summary string
}

func NewSummary(summary string) MemberSummary {
        return MemberSummary{Summary: summary}
}

func (k *MemberSummary) GetSummary() string {
        return k.Summary
}

func isCap(s string) bool {
        if len(s) == 0 {
                return false
        }
        firstRune := []rune(s)[0]
        return unicode.IsUpper(firstRune)
}

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	Description string
23	Modules []*Module
24	Packages []*Package
25	}
26
27	type Module struct {
28	MemberKind
29	MemberName
30	MemberSummary
31	Description string
32	Aliases []*Alias
33	Functions []*Function
34	Structs []*Struct
35	Traits []*Trait
36	}
37
38	type Alias struct {
39	MemberKind
40	MemberName
41	MemberSummary
42	Description string
43	Value string
44	Deprecated string
45	}
46
47	type Struct struct {
48	MemberKind
49	MemberName
50	MemberSummary
51	Description string
52	Aliases []*Alias
53	Constraints string
54	Convention string
55	Deprecated string
56	Fields []*Field
57	Functions []*Function
58	Parameters []*Parameter
59	ParentTraits []string
60	Signature string
61	}
62
63	type Function struct {
64	MemberKind
65	MemberName
66	MemberSummary
67	Description string
68	Args []*Arg
69	Overloads []*Function
70	Async bool
71	Constraints string
72	Deprecated string
73	IsDef bool
74	IsStatic bool
75	IsImplicitConversion bool
76	Raises bool
77	RaisesDoc string
78	ReturnType string
79	ReturnsDoc string
80	Signature string
81	Parameters []*Parameter
82	}
83
84	type Field struct {
85	MemberKind
86	MemberName
87	MemberSummary
88	Description string
89	Type string
90	}
91
92	type Trait struct {
93	MemberKind
94	MemberName
95	MemberSummary
96	Description string
97	Fields []*Field
98	Functions []*Function
99	ParentTraits []string
100	Deprecated string
101	}
102
103	type Arg struct {
104	MemberKind
105	MemberName
106	Description string
107	Convention string
108	Type string
109	PassingKind string
110	Default string
111	}
112
113	type Parameter struct {
114	MemberKind
115	MemberName
116	Description string
117	Type string
118	PassingKind string
119	Default string
120	}
121
122	func FromJson(data []byte) (*Docs, error) {	1✔
123	reader := bytes.NewReader(data)	1✔
124	dec := json.NewDecoder(reader)	1✔
125	dec.DisallowUnknownFields()	1✔
126		1✔
127	var docs Docs	1✔
128		1✔
129	if err := dec.Decode(&docs); err != nil {	1✔
130	return nil, err	×
131	}	×
132
133	cleanup(&docs)	1✔
134		1✔
135	return &docs, nil	1✔
136	}
137
138	type Kinded interface {
139	GetKind() string
140	}
141
142	type Named interface {
143	GetName() string
144	GetFileName() string
145	}
146
147	type Summarized interface {
148	GetSummary() string
149	}
150
151	type MemberKind struct {
152	Kind string
153	}
154
155	func NewKind(kind string) MemberKind {	12✔
156	return MemberKind{Kind: kind}	12✔
157	}	12✔
158
159	func (k *MemberKind) GetKind() string {	×
160	return k.Kind	×
161	}	×
162
163	type MemberName struct {
164	Name string
165	}
166
167	func NewName(name string) MemberName {	25✔
168	return MemberName{Name: name}	25✔
169	}	25✔
170
171	func (k *MemberName) GetName() string {	26✔
172	return k.Name	26✔
173	}	26✔
174
175	func (k *MemberName) GetFileName() string {	6✔
176	if CaseSensitiveSystem {	12✔
177	return k.Name	6✔
178	}	6✔
179	if isCap(k.Name) {	×
180	return k.Name + capitalFileMarker	×
181	}	×
182	return k.Name	×
183	}
184
185	type MemberSummary struct {
186	Summary string
187	}
188
NEW 189	func NewSummary(summary string) MemberSummary {	×
NEW 190	return MemberSummary{Summary: summary}	×
NEW 191	}	×
192
NEW 193	func (k *MemberSummary) GetSummary() string {	×
NEW 194	return k.Summary	×
NEW 195	}	×
196
197	func isCap(s string) bool {	×
198	if len(s) == 0 {	×
199	return false	×
200	}	×
201	firstRune := []rune(s)[0]	×
202	return unicode.IsUpper(firstRune)	×
203	}

mlange-42 / modo / 12775901286

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

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