Skip to content

Commit c91f455

Browse files
metal3dmetal3d
committed
Refacto + simplifications
1 parent f14db9a commit c91f455

File tree

2 files changed

+127
-90
lines changed

2 files changed

+127
-90
lines changed

‎ordering/main.go

+86-57
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ import (
1717
// will be moved.
1818
var DefaultOrder = []Order{Const, Var, Interface, Type, Func}
1919

20-
func formatWithCommand(content []byte, output string, opt ReorderConfig) (newcontent []byte, err error) {
20+
const reorderSignature = "// -- "
21+
22+
func formatWithCommand(content []byte, output []byte, opt ReorderConfig) (newcontent []byte, err error) {
2123
// we use the format command given by the user
2224
// on a temporary file we need to create and remove
2325
tmpfile, err := os.CreateTemp("", "")
@@ -27,7 +29,7 @@ func formatWithCommand(content []byte, output string, opt ReorderConfig) (newcon
2729
defer os.Remove(tmpfile.Name())
2830

2931
// write the temporary file
30-
if _, err := tmpfile.Write([]byte(output)); err != nil {
32+
if _, err := tmpfile.Write(output); err != nil {
3133
return content, errors.New("Failed to write temp file: " + err.Error())
3234
}
3335
tmpfile.Close()
@@ -58,7 +60,7 @@ func processConst(
5860
*lineNumberWhereInject = info.Constants[name].OpeningLine
5961
}
6062
for ln := sourceCode.OpeningLine - 1; ln < sourceCode.ClosingLine; ln++ {
61-
originalContent[ln] = "// -- " + sign
63+
originalContent[ln] = reorderSignature + sign
6264
}
6365
source = append(source, sourceCode.SourceCode)
6466
*removedLines += len(info.Constants)
@@ -84,7 +86,7 @@ func processExtractedFunction(
8486
*lineNumberWhereInject = info.Functions[name].OpeningLine
8587
}
8688
for ln := sourceCode.OpeningLine - 1; ln < sourceCode.ClosingLine; ln++ {
87-
originalContent[ln] = "// -- " + sign
89+
originalContent[ln] = reorderSignature + sign
8890
}
8991
source = append(source, "\n"+sourceCode.SourceCode)
9092
*removedLines += len(info.Functions)
@@ -113,7 +115,7 @@ func processFunctions(
113115
*lineNumberWhereInject = info.Functions[name].OpeningLine
114116
}
115117
for ln := sourceCode.OpeningLine - 1; ln < sourceCode.ClosingLine; ln++ {
116-
originalContent[ln] = "// -- " + sign
118+
originalContent[ln] = reorderSignature + sign
117119
}
118120
source = append(source, "\n"+sourceCode.SourceCode)
119121
*removedLines += len(info.Functions)
@@ -134,7 +136,7 @@ func processInterfaces(
134136
*lineNumberWhereInject = info.Interfaces[name].OpeningLine
135137
}
136138
for ln := sourceCode.OpeningLine - 1; ln < sourceCode.ClosingLine; ln++ {
137-
originalContent[ln] = "// -- " + sign
139+
originalContent[ln] = reorderSignature + sign
138140
}
139141
source = append(source, sourceCode.SourceCode)
140142
*removedLines += len(info.Interfaces)
@@ -155,7 +157,7 @@ func processTypes(
155157
}
156158
// replace the definitions by "// -- line to remove
157159
for ln := info.Types[typename].OpeningLine - 1; ln < info.Types[typename].ClosingLine; ln++ {
158-
originalContent[ln] = "// -- " + sign
160+
originalContent[ln] = reorderSignature + sign
159161
}
160162
*removedLines += info.Types[typename].ClosingLine - info.Types[typename].OpeningLine
161163
// add the struct definition to "source"
@@ -164,7 +166,7 @@ func processTypes(
164166
// same for constructors
165167
for _, constructor := range info.Constructors[typename] {
166168
for ln := constructor.OpeningLine - 1; ln < constructor.ClosingLine; ln++ {
167-
originalContent[ln] = "// -- " + sign
169+
originalContent[ln] = reorderSignature + sign
168170
}
169171
// add the constructor to "source"
170172
source = append(source, "\n"+constructor.SourceCode)
@@ -174,7 +176,7 @@ func processTypes(
174176
// same for methods
175177
for _, method := range info.Methods[typename] {
176178
for ln := method.OpeningLine - 1; ln < method.ClosingLine; ln++ {
177-
originalContent[ln] = "// -- " + sign
179+
originalContent[ln] = reorderSignature + sign
178180
}
179181
// add the method to "source"
180182
source = append(source, "\n"+method.SourceCode)
@@ -196,7 +198,7 @@ func processVars(
196198
*lineNumberWhereInject = info.Variables[name].OpeningLine
197199
}
198200
for ln := sourceCode.OpeningLine - 1; ln < sourceCode.ClosingLine; ln++ {
199-
originalContent[ln] = "// -- " + sign
201+
originalContent[ln] = reorderSignature + sign
200202
}
201203
source = append(source, sourceCode.SourceCode)
202204
*removedLines += len(info.Variables)
@@ -218,22 +220,7 @@ func ReorderSource(opt ReorderConfig) (string, error) {
218220
if opt.DefOrder == nil {
219221
opt.DefOrder = DefaultOrder
220222
}
221-
if len(opt.DefOrder) != len(DefaultOrder) {
222-
// wich one is missing?
223-
for _, order := range DefaultOrder {
224-
found := false
225-
for _, defOrder := range opt.DefOrder {
226-
if order == defOrder {
227-
found = true
228-
break
229-
}
230-
}
231-
if !found {
232-
// add it to the end
233-
opt.DefOrder = append(opt.DefOrder, order)
234-
}
235-
}
236-
}
223+
findMissingOrderElement(&opt)
237224

238225
var content []byte
239226
var err error
@@ -258,33 +245,18 @@ func ReorderSource(opt ReorderConfig) (string, error) {
258245

259246
// sort methods by name
260247
for _, method := range info.Methods {
261-
sort.Slice(method, func(i, j int) bool {
262-
return method[i].Name < method[j].Name
263-
})
248+
sortGoTypes(method)
264249
}
265250

266251
for _, constructor := range info.Constructors {
267-
sort.Slice(constructor, func(i, j int) bool {
268-
return constructor[i].Name < constructor[j].Name
269-
})
252+
sortGoTypes(constructor)
270253
}
271254

272-
functionNames := make([]string, 0, len(info.Functions))
273-
for functionName := range info.Functions {
274-
functionNames = append(functionNames, functionName)
275-
}
255+
functionNames := getKeys(info.Functions)
256+
varNames := getKeys(info.Variables)
257+
constNames := getKeys(info.Constants)
276258
sort.Strings(functionNames)
277-
278-
varNames := make([]string, 0, len(info.Variables))
279-
for varName := range info.Variables {
280-
varNames = append(varNames, varName)
281-
}
282259
sort.Strings(varNames)
283-
284-
constNames := make([]string, 0, len(info.Constants))
285-
for constName := range info.Constants {
286-
constNames = append(constNames, constName)
287-
}
288260
sort.Strings(constNames)
289261

290262
if opt.ReorderStructs {
@@ -375,34 +347,91 @@ func ReorderSource(opt ReorderConfig) (string, error) {
375347
originalContent = append(originalContent[:lineNumberWhereInject], append(source, originalContent[lineNumberWhereInject:]...)...)
376348

377349
// remove the lines that were marked as "// -- line to remove"
378-
temp := []string{}
379-
for _, line := range originalContent {
380-
if line != "// -- "+sign {
381-
temp = append(temp, line)
350+
originalContent = removeSignedLine(originalContent, sign)
351+
output := []byte(strings.Join(originalContent, "\n"))
352+
353+
// write in a temporary file and use "gofmt" to format it
354+
//newcontent := []byte(output)
355+
newcontent, err := formatSource(content, output, opt)
356+
if err != nil {
357+
return string(content), err
358+
}
359+
360+
if opt.Diff {
361+
return doDiff(content, newcontent, opt.Filename)
362+
}
363+
return string(newcontent), nil
364+
}
365+
366+
// findMissingOrderElement finds the missing order element.
367+
// If the default order is not complete, it will add the missing elements.
368+
func findMissingOrderElement(opt *ReorderConfig) {
369+
370+
if len(opt.DefOrder) != len(DefaultOrder) {
371+
// wich one is missing?
372+
for _, order := range DefaultOrder {
373+
found := false
374+
for _, defOrder := range opt.DefOrder {
375+
if order == defOrder {
376+
found = true
377+
break
378+
}
379+
}
380+
if !found {
381+
// add it to the end
382+
opt.DefOrder = append(opt.DefOrder, order)
383+
}
382384
}
383385
}
384-
originalContent = temp
385-
output := strings.Join(originalContent, "\n")
386+
}
387+
388+
func sortGoTypes(v []*GoType) {
389+
sort.Slice(v, func(i, j int) bool {
390+
return v[i].Name < v[j].Name
391+
})
392+
}
393+
394+
func getKeys(m map[string]*GoType) []string {
395+
keys := make([]string, len(m))
396+
i := 0
397+
for k := range m {
398+
keys[i] = k
399+
i++
400+
}
401+
return keys
402+
}
403+
404+
func formatSource(content, output []byte, opt ReorderConfig) ([]byte, error) {
386405

387406
// write in a temporary file and use "gofmt" to format it
388407
//newcontent := []byte(output)
389408
var newcontent []byte
409+
var err error
390410
switch opt.FormatCommand {
391411
case "gofmt":
392412
// format the temporary file
393413
newcontent, err = format.Source([]byte(output))
394414
if err != nil {
395-
return string(content), errors.New("Failed to format source: " + err.Error())
415+
return content, errors.New("Failed to format source: " + err.Error())
396416
}
397417
default:
398418
newcontent, err = formatWithCommand(content, output, opt)
399419
if err != nil {
400-
return string(content), errors.New("Failed to format source: " + err.Error())
420+
return content, errors.New("Failed to format source: " + err.Error())
401421
}
402422
}
403423

404-
if opt.Diff {
405-
return doDiff(content, newcontent, opt.Filename)
424+
return newcontent, nil
425+
}
426+
427+
func removeSignedLine(originalContent []string, sign string) []string {
428+
// remove the lines that were marked as "// -- line to remove"
429+
temp := []string{}
430+
for _, line := range originalContent {
431+
if line != reorderSignature+sign {
432+
temp = append(temp, line)
433+
}
406434
}
407-
return string(newcontent), nil
435+
436+
return temp
408437
}

‎ordering/parser.go

+41-33
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func Parse(filename string, src interface{}) (*ParsedInfo, error) {
6060
for _, decl := range f.Decls {
6161
switch d := decl.(type) {
6262
case *ast.FuncDecl:
63-
findConstructors(d, fset, sourceLines, methods, constructors)
63+
findConstructors(d, fset, sourceLines, constructors)
6464
}
6565
}
6666
// and now functions
@@ -108,7 +108,7 @@ func GetTypeComments(d *ast.GenDecl) (comments []string) {
108108
return
109109
}
110110

111-
func findConstructors(d *ast.FuncDecl, fset *token.FileSet, sourceLines []string, methods, constructors map[string][]*GoType) {
111+
func findConstructors(d *ast.FuncDecl, fset *token.FileSet, sourceLines []string, constructors map[string][]*GoType) {
112112

113113
if d.Type == nil || d.Type.Results == nil || len(d.Type.Results.List) == 0 { // no return type
114114
return
@@ -186,41 +186,49 @@ func findGlobalVarsAndConsts(d *ast.GenDecl, fset *token.FileSet, sourceLines []
186186
return
187187
}
188188
for _, spec := range d.Specs {
189-
if s, ok := spec.(*ast.ValueSpec); ok {
190-
for _, name := range s.Names {
191-
// log the source code for the variable or constant
192-
varDef := &GoType{
193-
Name: name.Name,
194-
OpeningLine: fset.Position(d.Pos()).Line,
195-
ClosingLine: fset.Position(d.End()).Line,
196-
}
197-
comments := GetTypeComments(d)
198-
if len(comments) > 0 {
199-
varDef.SourceCode = strings.Join(comments, "\n") + "\n"
200-
}
201-
varDef.SourceCode += strings.Join(sourceLines[varDef.OpeningLine-1:varDef.ClosingLine], "\n")
202-
varDef.OpeningLine -= len(comments)
203-
204-
// this time, if const or vars are defined in a parenthesis, the source code is the same for all
205-
// found var or const. So, what we do is to check if the source code is already in the map, and if
206-
// so, we skip it.
207-
// we will use the source code signature as the key for the map
208-
signature := fmt.Sprintf("%d-%d", varDef.OpeningLine, varDef.ClosingLine)
209-
if _, ok := varTypes[signature]; ok {
210-
continue
211-
}
212-
213-
switch d.Tok {
214-
case token.CONST:
215-
constTypes[signature] = varDef
216-
case token.VAR:
217-
varTypes[signature] = varDef
218-
}
219-
}
189+
s, ok := spec.(*ast.ValueSpec)
190+
if !ok {
191+
continue
192+
}
193+
for _, name := range s.Names {
194+
parseConstantAndVars(name, d, fset, sourceLines, varTypes, constTypes)
220195
}
221196
}
222197
}
223198

199+
func parseConstantAndVars(name *ast.Ident, d *ast.GenDecl, fset *token.FileSet, sourceLines []string, varTypes, constTypes map[string]*GoType) {
200+
201+
// log the source code for the variable or constant
202+
varDef := &GoType{
203+
Name: name.Name,
204+
OpeningLine: fset.Position(d.Pos()).Line,
205+
ClosingLine: fset.Position(d.End()).Line,
206+
}
207+
comments := GetTypeComments(d)
208+
if len(comments) > 0 {
209+
varDef.SourceCode = strings.Join(comments, "\n") + "\n"
210+
}
211+
varDef.SourceCode += strings.Join(sourceLines[varDef.OpeningLine-1:varDef.ClosingLine], "\n")
212+
varDef.OpeningLine -= len(comments)
213+
214+
// this time, if const or vars are defined in a parenthesis, the source code is the same for all
215+
// found var or const. So, what we do is to check if the source code is already in the map, and if
216+
// so, we skip it.
217+
// we will use the source code signature as the key for the map
218+
signature := fmt.Sprintf("%d-%d", varDef.OpeningLine, varDef.ClosingLine)
219+
if _, ok := varTypes[signature]; ok {
220+
return
221+
}
222+
223+
switch d.Tok {
224+
case token.CONST:
225+
constTypes[signature] = varDef
226+
case token.VAR:
227+
varTypes[signature] = varDef
228+
}
229+
230+
}
231+
224232
func findInterfaces(d *ast.GenDecl, fset *token.FileSet, sourceLines []string, interfaceNames *StingList, interfaceTypes map[string]*GoType) {
225233
// finc interfaces
226234
if d.Tok != token.TYPE {

0 commit comments

Comments
 (0)