From 7d904261ee5b3771615c356cb998dd26714c59aa Mon Sep 17 00:00:00 2001 From: hau Date: Sat, 28 Nov 2020 00:39:05 +0700 Subject: [PATCH] refactor: rename markdown.Base -> markdown.Node --- pkg/changelog/markdown.go | 18 +++++++++--------- pkg/markdown/generate.go | 2 +- pkg/markdown/generate_test.go | 4 ++-- pkg/markdown/{base.go => node.go} | 15 ++++++++------- pkg/markdown/{base_test.go => node_test.go} | 0 pkg/markdown/parse.go | 4 ++-- pkg/markdown/parse_test.go | 6 +++--- 7 files changed, 25 insertions(+), 24 deletions(-) rename pkg/markdown/{base.go => node.go} (77%) rename pkg/markdown/{base_test.go => node_test.go} (100%) diff --git a/pkg/changelog/markdown.go b/pkg/changelog/markdown.go index 32bebdb..76b0f5f 100644 --- a/pkg/changelog/markdown.go +++ b/pkg/changelog/markdown.go @@ -35,7 +35,7 @@ func (g *MarkdownGenerator) Generate(commits []convention.Commit) string { return "" } - bases := make([]markdown.Base, 0, defaultBasesLen) + bases := make([]markdown.Node, 0, defaultBasesLen) // title bases = append(bases, markdown.NewHeader(1, title)) @@ -55,17 +55,17 @@ func (g *MarkdownGenerator) Generate(commits []convention.Commit) string { return markdown.Generate(bases) } -func (g *MarkdownGenerator) getNewMarkdownBases(commits []convention.Commit) []markdown.Base { +func (g *MarkdownGenerator) getNewMarkdownBases(commits []convention.Commit) []markdown.Node { if len(commits) == 0 { return nil } - result := make([]markdown.Base, 0, defaultBasesLen) + result := make([]markdown.Node, 0, defaultBasesLen) - commitBases := make(map[string][]markdown.Base) - commitBases[addedType] = make([]markdown.Base, 0, defaultBasesLen) - commitBases[fixedType] = make([]markdown.Base, 0, defaultBasesLen) - commitBases[othersType] = make([]markdown.Base, 0, defaultBasesLen) + commitBases := make(map[string][]markdown.Node) + commitBases[addedType] = make([]markdown.Node, 0, defaultBasesLen) + commitBases[fixedType] = make([]markdown.Node, 0, defaultBasesLen) + commitBases[othersType] = make([]markdown.Node, 0, defaultBasesLen) for _, commit := range commits { t := getType(commit.Type) @@ -99,8 +99,8 @@ func (g *MarkdownGenerator) getNewMarkdownBases(commits []convention.Commit) []m return result } -func (g *MarkdownGenerator) getOldBases() []markdown.Base { - result := make([]markdown.Base, 0, defaultBasesLen) +func (g *MarkdownGenerator) getOldBases() []markdown.Node { + result := make([]markdown.Node, 0, defaultBasesLen) lines := strings.Split(g.oldData, string(markdown.NewlineToken)) diff --git a/pkg/markdown/generate.go b/pkg/markdown/generate.go index c549703..a5b943c 100644 --- a/pkg/markdown/generate.go +++ b/pkg/markdown/generate.go @@ -2,7 +2,7 @@ package markdown import "strings" -func Generate(bases []Base) string { +func Generate(bases []Node) string { lines := make([]string, len(bases)) for i, base := range bases { diff --git a/pkg/markdown/generate_test.go b/pkg/markdown/generate_test.go index 8fb69f5..86e35e8 100644 --- a/pkg/markdown/generate_test.go +++ b/pkg/markdown/generate_test.go @@ -9,12 +9,12 @@ import ( func TestGenerate(t *testing.T) { tests := []struct { name string - bases []Base + bases []Node want string }{ { name: "normal", - bases: []Base{ + bases: []Node{ header{ level: 1, text: "header", diff --git a/pkg/markdown/base.go b/pkg/markdown/node.go similarity index 77% rename from pkg/markdown/base.go rename to pkg/markdown/node.go index 4d4ac51..3b537c6 100644 --- a/pkg/markdown/base.go +++ b/pkg/markdown/node.go @@ -8,13 +8,14 @@ const ( headerToken = '#' defaultListToken = '-' alternativeListToken = '*' - spaceToken = ' ' - NewlineToken = '\n' + + spaceToken = ' ' + NewlineToken = '\n' ) -// Base is single markdown syntax representation +// Node is single markdown syntax representation // Example: header, list, ... -type Base interface { +type Node interface { String() string } @@ -23,7 +24,7 @@ type header struct { text string } -func NewHeader(level int, text string) Base { +func NewHeader(level int, text string) Node { return header{ level: level, text: text, @@ -49,7 +50,7 @@ type listItem struct { text string } -func NewListItem(text string) Base { +func NewListItem(text string) Node { return listItem{ text: text, } @@ -61,6 +62,6 @@ func (i listItem) String() string { return string(defaultListToken) + string(spaceToken) + text } -func Equal(base1, base2 Base) bool { +func Equal(base1, base2 Node) bool { return base1.String() == base2.String() } diff --git a/pkg/markdown/base_test.go b/pkg/markdown/node_test.go similarity index 100% rename from pkg/markdown/base_test.go rename to pkg/markdown/node_test.go diff --git a/pkg/markdown/parse.go b/pkg/markdown/parse.go index eed8a1b..45e7e2c 100644 --- a/pkg/markdown/parse.go +++ b/pkg/markdown/parse.go @@ -6,8 +6,8 @@ const ( defaultBaseLen = 10 ) -func Parse(lines []string) []Base { - bases := make([]Base, 0, defaultBaseLen) +func Parse(lines []string) []Node { + bases := make([]Node, 0, defaultBaseLen) for _, line := range lines { if line == "" { diff --git a/pkg/markdown/parse_test.go b/pkg/markdown/parse_test.go index 893c53a..9b6d5c9 100644 --- a/pkg/markdown/parse_test.go +++ b/pkg/markdown/parse_test.go @@ -10,7 +10,7 @@ func TestParse(t *testing.T) { tests := []struct { name string lines []string - want []Base + want []Node }{ { name: "level 1", @@ -18,7 +18,7 @@ func TestParse(t *testing.T) { "# abc", "- xyz", }, - want: []Base{ + want: []Node{ header{ level: 1, text: "abc", @@ -34,7 +34,7 @@ func TestParse(t *testing.T) { "### xyz", "* abc", }, - want: []Base{ + want: []Node{ header{ level: 3, text: "xyz",