mainnika/mongox-go-driver
1
0
Fork 0
mirror of https://github.com/mainnika/mongox-go-driver.git synced 2026-05-22 15:53:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use named returns for the code style consistency

Browse Source
This commit is contained in:
Nikita Tokarchuk
2020-07-13 03:12:39 +02:00
parent 9cf3551c20
commit 72e74a65b6
23 changed files with 145 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mongox/database/count.go
+3 -3
View File
@@ -11,7 +11,7 @@ import (
// Count function counts documents in the database by query
// target is used only to get collection by tag so it'd be better to use nil ptr here
func (d *Database) Count(target interface{}, filters ...interface{}) (int64, error) {
func (d *Database) Count(target interface{}, filters ...interface{}) (result int64, err error) {
collection := d.GetCollectionOf(target)
opts := options.Count()
@@ -20,7 +20,7 @@ func (d *Database) Count(target interface{}, filters ...interface{}) (int64, err
opts.Limit = composed.Limiter()
opts.Skip = composed.Skipper()
result, err := collection.CountDocuments(d.Context(), composed.M(), opts)
result, err = collection.CountDocuments(d.Context(), composed.M(), opts)
if err == mongox.ErrNoDocuments {
return 0, err
}
@@ -28,5 +28,5 @@ func (d *Database) Count(target interface{}, filters ...interface{}) (int64, err
return 0, fmt.Errorf("can't decode desult: %w", err)
}
return result, nil
return
}
mongox/database/database.go
+13 -10
View File
@@ -22,17 +22,18 @@ type Database struct {
}
// NewDatabase function creates new database instance with mongo client and empty context
func NewDatabase(client *mongox.Client, dbname string) mongox.Database {
func NewDatabase(client *mongox.Client, dbname string) (db mongox.Database) {
db := &Database{}
db.client = client
db.dbname = dbname
db = &Database{
client: client,
dbname: dbname,
}
return db
return
}
// Client function returns a mongo client
func (d *Database) Client() *mongox.Client {
func (d *Database) Client() (client *mongox.Client) {
return d.client
}
@@ -48,22 +49,24 @@ func (d *Database) Context() (ctx context.Context) {
}
// Name function returns a database name
func (d *Database) Name() string {
func (d *Database) Name() (name string) {
return d.dbname
}
// New function creates new database context with same client
func (d *Database) New(ctx context.Context) mongox.Database {
func (d *Database) New(ctx context.Context) (db mongox.Database) {
if ctx == nil {
ctx = context.Background()
}
return &Database{
db = &Database{
client: d.client,
dbname: d.dbname,
ctx: ctx,
}
return
}
// GetCollectionOf returns the collection object by the «collection» tag of the given document;
@@ -72,7 +75,7 @@ func (d *Database) New(ctx context.Context) mongox.Database {
// base.ObjectID `bson:",inline" json:",inline" collection:"foobars"`
// ...
// Will panic if there is no «collection» tag
func (d *Database) GetCollectionOf(document interface{}) *mongox.Collection {
func (d *Database) GetCollectionOf(document interface{}) (collection *mongox.Collection) {
el := reflect.TypeOf(document).Elem()
numField := el.NumField()
mongox/database/deletearray.go
+3 -3
View File
@@ -11,7 +11,7 @@ import (
)
// DeleteArray removes documents list from a database by their ids
func (d *Database) DeleteArray(target interface{}) error {
func (d *Database) DeleteArray(target interface{}) (err error) {
targetV := reflect.ValueOf(target)
targetT := targetV.Type()
@@ -52,8 +52,8 @@ func (d *Database) DeleteArray(target interface{}) error {
return fmt.Errorf("can't create find and delete result: %w", err)
}
if result.DeletedCount != int64(targetLen) {
return fmt.Errorf("can't verify delete result: removed count mismatch %d != %d", result.DeletedCount, targetLen)
err = fmt.Errorf("can't verify delete result: removed count mismatch %d != %d", result.DeletedCount, targetLen)
}
return nil
return
}
mongox/database/deleteone.go
+3 -3
View File
@@ -14,7 +14,7 @@ import (
)
// DeleteOne removes a document from a database and then returns it into target
func (d *Database) DeleteOne(target interface{}, filters ...interface{}) error {
func (d *Database) DeleteOne(target interface{}, filters ...interface{}) (err error) {
collection := d.GetCollectionOf(target)
opts := &options.FindOneAndDeleteOptions{}
@@ -38,7 +38,7 @@ func (d *Database) DeleteOne(target interface{}, filters ...interface{}) error {
return fmt.Errorf("can't create find one and delete result: %w", result.Err())
}
err := result.Decode(target)
err = result.Decode(target)
if err == mongox.ErrNoDocuments {
return err
}
@@ -46,5 +46,5 @@ func (d *Database) DeleteOne(target interface{}, filters ...interface{}) error {
return fmt.Errorf("can't decode result: %w", err)
}
return nil
return
}
mongox/database/index.go
+7 -5
View File
@@ -21,7 +21,7 @@ import (
// `index:"-,+foo,+-bar,unique,allowNull"` -- https://docs.mongodb.com/manual/core/index-partial
// `index:"-,unique,allowNull,expireAfter=86400"` -- https://docs.mongodb.com/manual/core/index-ttl
// `index:"-,unique,allowNull,expireAfter={{.Expire}}"` -- evaluate index as a golang template with `cfg` arguments
func (d *Database) IndexEnsure(cfg interface{}, document interface{}) error {
func (d *Database) IndexEnsure(cfg interface{}, document interface{}) (err error) {
el := reflect.ValueOf(document).Elem().Type()
numField := el.NumField()
@@ -41,8 +41,10 @@ func (d *Database) IndexEnsure(cfg interface{}, document interface{}) error {
return fmt.Errorf("bson tag is not defined for field:%v document:%v", field, document)
}
tmpBuffer := &bytes.Buffer{}
tpl, err := template.New("").Parse(indexTag)
var tmpBuffer = &bytes.Buffer{}
var tpl *template.Template
tpl, err = template.New("").Parse(indexTag)
if err != nil {
panic(fmt.Errorf("invalid prop template, %v", indexTag))
}
@@ -126,9 +128,9 @@ func (d *Database) IndexEnsure(cfg interface{}, document interface{}) error {
_, err = documents.Indexes().CreateOne(d.Context(), mongo.IndexModel{Keys: index, Options: opts})
if err != nil {
return err
return
}
}
return nil
return
}
mongox/database/loadarray.go
+4 -5
View File
@@ -10,7 +10,7 @@ import (
)
// LoadArray loads an array of documents from the database by query
func (d *Database) LoadArray(target interface{}, filters ...interface{}) error {
func (d *Database) LoadArray(target interface{}, filters ...interface{}) (err error) {
targetV := reflect.ValueOf(target)
targetT := targetV.Type()
@@ -36,7 +36,7 @@ func (d *Database) LoadArray(target interface{}, filters ...interface{}) error {
hasPreloader, _ := composed.Preloader()
var result *mongox.Cursor
var err error
var i int
if hasPreloader {
result, err = d.createAggregateLoad(zeroElem.Interface(), composed)
@@ -44,11 +44,10 @@ func (d *Database) LoadArray(target interface{}, filters ...interface{}) error {
result, err = d.createSimpleLoad(zeroElem.Interface(), composed)
}
if err != nil {
return fmt.Errorf("can't create find result: %w", err)
err = fmt.Errorf("can't create find result: %w", err)
return
}
var i int
for i = 0; result.Next(d.Context()); {
if targetSliceV.Len() == i {
elem := reflect.New(targetSliceElemT.Elem())
mongox/database/loadone.go
+1 -2
View File
@@ -9,13 +9,12 @@ import (
)
// LoadOne function loads a first single target document by a query
func (d *Database) LoadOne(target interface{}, filters ...interface{}) error {
func (d *Database) LoadOne(target interface{}, filters ...interface{}) (err error) {
composed := query.Compose(append(filters, query.Limit(1))...)
hasPreloader, _ := composed.Preloader()
var result *mongox.Cursor
var err error
if hasPreloader {
result, err = d.createAggregateLoad(target, composed)
mongox/database/loadstream.go
+5 -5
View File
@@ -8,10 +8,9 @@ import (
)
// LoadStream function loads documents one by one into a target channel
func (d *Database) LoadStream(target interface{}, filters ...interface{}) (mongox.StreamLoader, error) {
func (d *Database) LoadStream(target interface{}, filters ...interface{}) (loader mongox.StreamLoader, err error) {
var cursor *mongox.Cursor
var err error
composed := query.Compose(filters...)
hasPreloader, _ := composed.Preloader()
@@ -22,10 +21,11 @@ func (d *Database) LoadStream(target interface{}, filters ...interface{}) (mongo
cursor, err = d.createSimpleLoad(target, composed)
}
if err != nil {
return nil, fmt.Errorf("can't create find result: %w", err)
err = fmt.Errorf("can't create find result: %w", err)
return
}
l := &StreamLoader{cur: cursor, ctx: d.Context(), target: target}
loader = &StreamLoader{cur: cursor, ctx: d.Context(), target: target}
return l, nil
return
}
mongox/database/saveone.go
+1 -1
View File
@@ -12,7 +12,7 @@ import (
)
// SaveOne saves a single source document to the database
func (d *Database) SaveOne(source interface{}) error {
func (d *Database) SaveOne(source interface{}) (err error) {
collection := d.GetCollectionOf(source)
opts := options.FindOneAndReplace()
mongox/database/streamloader.go
+21 -30
View File
@@ -2,7 +2,6 @@ package database
import (
"context"
"fmt"
"github.com/mainnika/mongox-go-driver/v2/mongox"
"github.com/mainnika/mongox-go-driver/v2/mongox/base"
@@ -16,64 +15,56 @@ type StreamLoader struct {
}
// DecodeNext loads next documents to a target or returns an error
func (l *StreamLoader) DecodeNext() error {
func (l *StreamLoader) DecodeNext() (err error) {
hasNext := l.cur.Next(l.ctx)
if l.cur.Err() != nil {
return l.cur.Err()
}
if !hasNext {
return mongox.ErrNoDocuments
}
base.Reset(l.target)
err := l.cur.Decode(l.target)
err = l.Next()
if err != nil {
return fmt.Errorf("can't decode desult: %w", err)
return
}
return nil
err = l.Decode()
if err != nil {
return
}
return
}
// Decode function decodes the current cursor document into the target
func (l *StreamLoader) Decode() error {
func (l *StreamLoader) Decode() (err error) {
base.Reset(l.target)
err := l.cur.Decode(l.target)
if err != nil {
return fmt.Errorf("can't decode desult: %w", err)
}
err = l.cur.Decode(l.target)
return nil
return
}
// Next loads next documents but doesn't perform decoding
func (l *StreamLoader) Next() error {
func (l *StreamLoader) Next() (err error) {
hasNext := l.cur.Next(l.ctx)
err = l.cur.Err()
if l.cur.Err() != nil {
return l.cur.Err()
if err != nil {
return
}
if !hasNext {
return mongox.ErrNoDocuments
err = mongox.ErrNoDocuments
}
return nil
return
}
func (l *StreamLoader) Cursor() *mongox.Cursor {
func (l *StreamLoader) Cursor() (cursor *mongox.Cursor) {
return l.cur
}
// Close cursor
func (l *StreamLoader) Close() error {
func (l *StreamLoader) Close() (err error) {
return l.cur.Close(l.ctx)
}
func (l *StreamLoader) Err() error {
func (l *StreamLoader) Err() (err error) {
return l.cur.Err()
}