-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(fixer v2): yaml, update replacer (#122)
# Description - Added yaml handler - preserve ident context when apply replacer
- Loading branch information
Showing
4 changed files
with
327 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
package fixerv2 | ||
|
||
import ( | ||
"log" | ||
"os" | ||
|
||
"gopkg.in/yaml.v3" | ||
) | ||
|
||
type FixRule struct { | ||
Name string `yaml:"name"` | ||
Pattern string `yaml:"pattern"` | ||
Replacement string `yaml:"replacement"` | ||
} | ||
|
||
type RulesConfig struct { | ||
Rules []FixRule `yaml:"rules"` | ||
} | ||
|
||
func Load(path string) ([]FixRule, error) { | ||
data, err := os.ReadFile(path) | ||
if err != nil { | ||
return nil, err | ||
} | ||
var cfg RulesConfig | ||
if err := yaml.Unmarshal(data, &cfg); err != nil { | ||
return nil, err | ||
} | ||
return cfg.Rules, nil | ||
} | ||
|
||
func Apply(subject string, rules []FixRule) string { | ||
result := subject | ||
for _, rule := range rules { | ||
pat, err := Lex(rule.Pattern) | ||
if err != nil { | ||
log.Printf("failed to parse pattern %q: %v", rule.Pattern, err) | ||
continue | ||
} | ||
nodes, err := Parse(pat) | ||
if err != nil { | ||
log.Printf("failed to parse pattern %q: %v", rule.Pattern, err) | ||
continue | ||
} | ||
replacement, err := Lex(rule.Replacement) | ||
if err != nil { | ||
log.Printf("failed to parse replacement %q: %v", rule.Replacement, err) | ||
continue | ||
} | ||
replacementNodes, err := Parse(replacement) | ||
if err != nil { | ||
log.Printf("failed to parse replacement %q: %v", rule.Replacement, err) | ||
continue | ||
} | ||
|
||
repl := NewReplacer(nodes, replacementNodes) | ||
newResult := repl.ReplaceAll(result) | ||
if newResult != result { | ||
log.Printf("applied rule %q: %q -> %q", rule.Name, result, newResult) | ||
} | ||
result = newResult | ||
} | ||
return result | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
package fixerv2 | ||
|
||
import ( | ||
"os" | ||
"testing" | ||
) | ||
|
||
func TestLoadFixRules(t *testing.T) { | ||
tests := []struct { | ||
name string | ||
yamlContent string | ||
wantRules []FixRule | ||
wantErr bool | ||
}{ | ||
{ | ||
name: "valid rules", | ||
yamlContent: ` | ||
rules: | ||
- name: simple replacement | ||
pattern: ":[name]" | ||
replacement: "Hello, :[name]!" | ||
- name: arithmetic replacement | ||
pattern: ":[lhs] + :[rhs]" | ||
replacement: ":[rhs] - :[lhs]" | ||
`, | ||
wantRules: []FixRule{ | ||
{ | ||
Name: "simple replacement", | ||
Pattern: ":[name]", | ||
Replacement: "Hello, :[name]!", | ||
}, | ||
{ | ||
Name: "arithmetic replacement", | ||
Pattern: ":[lhs] + :[rhs]", | ||
Replacement: ":[rhs] - :[lhs]", | ||
}, | ||
}, | ||
wantErr: false, | ||
}, | ||
{ | ||
name: "invalid yaml", | ||
yamlContent: ` | ||
rules: | ||
- name: missing colon | ||
pattern ":[abc]" | ||
replacement: "Should fail" | ||
`, | ||
wantRules: nil, | ||
wantErr: true, | ||
}, | ||
{ | ||
name: "golang lint rules", | ||
yamlContent: ` | ||
rules: | ||
- name: if err handling | ||
pattern: "if err != nil { return err }" | ||
replacement: "if err != nil { return fmt.Errorf(\"failed to process: %w\", err) }" | ||
- name: context timeout | ||
pattern: "context.WithTimeout(:[ctx], :[duration])" | ||
replacement: "context.WithTimeout(:[ctx], :[duration])\ndefer cancel()" | ||
- name: slice capacity | ||
pattern: "make([]:[type], 0)" | ||
replacement: "make([]:[type], 0, :[capacity])" | ||
`, | ||
wantRules: []FixRule{ | ||
{ | ||
Name: "if err handling", | ||
Pattern: "if err != nil { return err }", | ||
Replacement: "if err != nil { return fmt.Errorf(\"failed to process: %w\", err) }", | ||
}, | ||
{ | ||
Name: "context timeout", | ||
Pattern: "context.WithTimeout(:[ctx], :[duration])", | ||
Replacement: "context.WithTimeout(:[ctx], :[duration])\ndefer cancel()", | ||
}, | ||
{ | ||
Name: "slice capacity", | ||
Pattern: "make([]:[type], 0)", | ||
Replacement: "make([]:[type], 0, :[capacity])", | ||
}, | ||
}, | ||
wantErr: false, | ||
}, | ||
} | ||
|
||
for _, tt := range tests { | ||
t.Run(tt.name, func(t *testing.T) { | ||
tmpfile, err := os.CreateTemp("", "rules_*.yaml") | ||
if err != nil { | ||
t.Fatalf("TempFile error: %v", err) | ||
} | ||
defer os.Remove(tmpfile.Name()) | ||
|
||
if _, err := tmpfile.Write([]byte(tt.yamlContent)); err != nil { | ||
t.Fatalf("Write error: %v", err) | ||
} | ||
if err := tmpfile.Close(); err != nil { | ||
t.Fatalf("Close error: %v", err) | ||
} | ||
|
||
rules, err := Load(tmpfile.Name()) | ||
if tt.wantErr { | ||
if err == nil { | ||
t.Fatalf("expected error but got none") | ||
} | ||
return | ||
} | ||
if err != nil { | ||
t.Fatalf("unexpected error: %v", err) | ||
} | ||
|
||
if len(rules) != len(tt.wantRules) { | ||
t.Fatalf("expected %d rule(s), got %d", len(tt.wantRules), len(rules)) | ||
} | ||
|
||
for i, want := range tt.wantRules { | ||
got := rules[i] | ||
if got.Name != want.Name { | ||
t.Errorf("rule[%d] Name: got %q, want %q", i, got.Name, want.Name) | ||
} | ||
if got.Pattern != want.Pattern { | ||
t.Errorf("rule[%d] Pattern: got %q, want %q", i, got.Pattern, want.Pattern) | ||
} | ||
if got.Replacement != want.Replacement { | ||
t.Errorf("rule[%d] Replacement: got %q, want %q", i, got.Replacement, want.Replacement) | ||
} | ||
} | ||
}) | ||
} | ||
} |