0d4cb92dad
## 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)
86 lines
2.6 KiB
Go
86 lines
2.6 KiB
Go
package codegen
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"google.golang.org/protobuf/compiler/protogen"
|
|
"google.golang.org/protobuf/types/dynamicpb"
|
|
|
|
ormv1alpha1 "github.com/cosmos/cosmos-sdk/api/cosmos/orm/v1alpha1"
|
|
"github.com/cosmos/cosmos-sdk/orm/model/ormtable"
|
|
)
|
|
|
|
type singletonGen struct {
|
|
fileGen
|
|
msg *protogen.Message
|
|
table *ormv1alpha1.SingletonDescriptor
|
|
ormTable ormtable.Table
|
|
}
|
|
|
|
func newSingletonGen(fileGen fileGen, msg *protogen.Message, table *ormv1alpha1.SingletonDescriptor) (*singletonGen, error) {
|
|
s := &singletonGen{fileGen: fileGen, msg: msg, table: table}
|
|
var err error
|
|
s.ormTable, err = ormtable.Build(ormtable.Options{
|
|
MessageType: dynamicpb.NewMessageType(msg.Desc),
|
|
SingletonDescriptor: table,
|
|
})
|
|
return s, err
|
|
}
|
|
|
|
func (s singletonGen) gen() {
|
|
s.genInterface()
|
|
s.genStruct()
|
|
s.genInterfaceGuard()
|
|
s.genMethods()
|
|
s.genConstructor()
|
|
}
|
|
|
|
func (s singletonGen) genInterface() {
|
|
s.P("// singleton store")
|
|
s.P("type ", s.messageTableInterfaceName(s.msg), " interface {")
|
|
s.P("Get(ctx ", contextPkg.Ident("Context"), ") (*", s.msg.GoIdent.GoName, ", error)")
|
|
s.P("Save(ctx ", contextPkg.Ident("Context"), ", ", s.param(s.msg.GoIdent.GoName), "*", s.msg.GoIdent.GoName, ") error")
|
|
s.P("}")
|
|
s.P()
|
|
}
|
|
|
|
func (s singletonGen) genStruct() {
|
|
s.P("type ", s.messageTableReceiverName(s.msg), " struct {")
|
|
s.P("table ", ormTablePkg.Ident("Table"))
|
|
s.P("}")
|
|
s.P()
|
|
}
|
|
|
|
func (s singletonGen) genInterfaceGuard() {
|
|
s.P("var _ ", s.messageTableInterfaceName(s.msg), " = ", s.messageTableReceiverName(s.msg), "{}")
|
|
}
|
|
|
|
func (s singletonGen) genMethods() {
|
|
receiver := fmt.Sprintf("func (x %s) ", s.messageTableReceiverName(s.msg))
|
|
varName := s.param(s.msg.GoIdent.GoName)
|
|
// Get
|
|
s.P(receiver, "Get(ctx ", contextPkg.Ident("Context"), ") (*", s.msg.GoIdent.GoName, ", error) {")
|
|
s.P(varName, " := &", s.msg.GoIdent.GoName, "{}")
|
|
s.P("_, err := x.table.Get(ctx, ", varName, ")")
|
|
s.P("return ", varName, ", err")
|
|
s.P("}")
|
|
s.P()
|
|
|
|
// Save
|
|
s.P(receiver, "Save(ctx ", contextPkg.Ident("Context"), ", ", varName, " *", s.msg.GoIdent.GoName, ") error {")
|
|
s.P("return x.table.Save(ctx, ", varName, ")")
|
|
s.P("}")
|
|
s.P()
|
|
}
|
|
|
|
func (s singletonGen) genConstructor() {
|
|
iface := s.messageTableInterfaceName(s.msg)
|
|
s.P("func New", iface, "(db ", ormTablePkg.Ident("Schema"), ") (", iface, ", error) {")
|
|
s.P("table := db.GetTable(&", s.msg.GoIdent.GoName, "{})")
|
|
s.P("if table == nil {")
|
|
s.P("return nil, ", ormErrPkg.Ident("TableNotFound.Wrap"), "(string((&", s.msg.GoIdent.GoName, "{}).ProtoReflect().Descriptor().FullName()))")
|
|
s.P("}")
|
|
s.P("return &", s.messageTableReceiverName(s.msg), "{table}, nil")
|
|
s.P("}")
|
|
}
|