cosmos-sdk/orm/internal/codegen/file.go
Aaron Craelius 0d4cb92dad
refactor(orm)!: rename table interfaces from Store -> Table in codegen (#11176)
## Description

I realize it's more intuitive to name the interfaces in codegen `FooTable` rather than `FooStore` for the type `Foo`.

Since we (and possibly others) are starting to build off of this, better to change now rather than later.

How does this change look?



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2022-02-14 15:23:52 +00:00

167 lines
4.3 KiB
Go

package codegen
import (
"path/filepath"
"strings"
"github.com/cosmos/cosmos-proto/generator"
"github.com/iancoleman/strcase"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
v1alpha1 "github.com/cosmos/cosmos-sdk/api/cosmos/orm/v1alpha1"
)
type fileGen struct {
*generator.GeneratedFile
file *protogen.File
}
func (f fileGen) gen() error {
f.P("// Code generated by protoc-gen-go-cosmos-orm. DO NOT EDIT.")
f.P()
f.P("package ", f.file.GoPackageName)
stores := make([]*protogen.Message, 0)
for _, msg := range f.file.Messages {
tableDesc := proto.GetExtension(msg.Desc.Options(), v1alpha1.E_Table).(*v1alpha1.TableDescriptor)
if tableDesc != nil {
tableGen, err := newTableGen(f, msg, tableDesc)
if err != nil {
return err
}
tableGen.gen()
}
singletonDesc := proto.GetExtension(msg.Desc.Options(), v1alpha1.E_Singleton).(*v1alpha1.SingletonDescriptor)
if singletonDesc != nil {
// do some singleton magic
singletonGen, err := newSingletonGen(f, msg, singletonDesc)
if err != nil {
return err
}
singletonGen.gen()
}
if tableDesc != nil || singletonDesc != nil { // message is one of the tables,
stores = append(stores, msg)
}
}
f.genStoreInterface(stores)
f.genStoreStruct(stores)
f.genStoreMethods(stores)
f.genStoreInterfaceGuard()
f.genStoreConstructor(stores)
return nil
}
func (f fileGen) genStoreInterface(stores []*protogen.Message) {
f.P("type ", f.storeInterfaceName(), " interface {")
for _, store := range stores {
name := f.messageTableInterfaceName(store)
f.P(name, "()", name)
}
f.P()
f.P("doNotImplement()")
f.P("}")
f.P()
}
func (f fileGen) genStoreStruct(stores []*protogen.Message) {
// struct
f.P("type ", f.storeStructName(), " struct {")
for _, message := range stores {
f.P(f.param(message.GoIdent.GoName), " ", f.messageTableInterfaceName(message))
}
f.P("}")
}
func (f fileGen) storeAccessorName() string {
return f.storeInterfaceName()
}
func (f fileGen) storeInterfaceName() string {
return strcase.ToCamel(f.fileShortName()) + "Store"
}
func (f fileGen) storeStructName() string {
return strcase.ToLowerCamel(f.fileShortName()) + "Store"
}
func (f fileGen) fileShortName() string {
filename := f.file.Proto.GetName()
shortName := filepath.Base(filename)
i := strings.Index(shortName, ".")
if i > 0 {
return shortName[:i]
}
return strcase.ToCamel(shortName)
}
func (f fileGen) messageTableInterfaceName(m *protogen.Message) string {
return m.GoIdent.GoName + "Table"
}
func (f fileGen) messageReaderInterfaceName(m *protogen.Message) string {
return m.GoIdent.GoName + "Reader"
}
func (f fileGen) messageTableVar(m *protogen.Message) string {
return f.param(m.GoIdent.GoName + "Table")
}
func (f fileGen) param(name string) string {
return strcase.ToLowerCamel(name)
}
func (f fileGen) messageTableReceiverName(m *protogen.Message) string {
return f.param(f.messageTableInterfaceName(m))
}
func (f fileGen) messageConstructorName(m *protogen.Message) string {
return "New" + f.messageTableInterfaceName(m)
}
func (f fileGen) genStoreMethods(stores []*protogen.Message) {
// getters
for _, msg := range stores {
name := f.messageTableInterfaceName(msg)
f.P("func(x ", f.storeStructName(), ") ", name, "() ", name, "{")
f.P("return x.", f.param(msg.GoIdent.GoName))
f.P("}")
f.P()
}
f.P("func(", f.storeStructName(), ") doNotImplement() {}")
f.P()
}
func (f fileGen) genStoreInterfaceGuard() {
f.P("var _ ", f.storeInterfaceName(), " = ", f.storeStructName(), "{}")
}
func (f fileGen) genStoreConstructor(stores []*protogen.Message) {
f.P("func New", f.storeInterfaceName(), "(db ", ormTablePkg.Ident("Schema"), ") (", f.storeInterfaceName(), ", error) {")
for _, store := range stores {
f.P(f.messageTableReceiverName(store), ", err := ", f.messageConstructorName(store), "(db)")
f.P("if err != nil {")
f.P("return nil, err")
f.P("}")
f.P()
}
f.P("return ", f.storeStructName(), "{")
for _, store := range stores {
f.P(f.messageTableReceiverName(store), ",")
}
f.P("}, nil")
f.P("}")
}
func (f fileGen) fieldsToCamelCase(fields string) string {
splitFields := strings.Split(fields, ",")
camelFields := make([]string, len(splitFields))
for i, field := range splitFields {
camelFields[i] = strcase.ToCamel(field)
}
return strings.Join(camelFields, "")
}