extended interface

crud.go

@@ -27,7 +27,7 @@ func (e *ErrorWithStack) Stack() string {
 }
 
 // CreateDocument creates a document from specified model
-func CreateDocument(db *Database, m ModelInterface) error {
+func (db *MgoDatabase) CreateDocument(m ModelInterface) error {
 	m.PrepareInsert()
 
 	c := db.C(GetCollectionName(m))
@@ -37,7 +37,7 @@ func CreateDocument(db *Database, m ModelInterface) error {
 }
 
 // ReadDocument gets one document via its id
-func ReadDocument(db *Database, m ModelInterface, selector bson.M) error {
+func (db *MgoDatabase) ReadDocument(m ModelInterface, selector bson.M) error {
 	c := db.C(GetCollectionName(m))
 
 	q := c.FindId(m.GetID())
@@ -136,7 +136,7 @@ func idToObjectID(filter interface{}) {
 }
 
 // ReadCollection gets the filtered collection of the model
-func ReadCollection(db *Database, results interface{}, filter bson.M, selector bson.M, offset int, limit int, sort []string, pipelineModifier PipelineModifierFunction) (err error) {
+func (db *MgoDatabase) ReadCollection(results interface{}, filter bson.M, selector bson.M, offset int, limit int, sort []string, pipelineModifier PipelineModifierFunction) (err error) {
 	defer func() {
 		if r := recover(); r != nil {
 			err = &ErrorWithStack{Message: fmt.Sprintf("%v", r), StackTrace: string(debug.Stack())}
@@ -243,7 +243,7 @@ func ReadCollection(db *Database, results interface{}, filter bson.M, selector b
 }
 
 // ReadCollectionCount gets the count of elements in filtered collection
-func ReadCollectionCount(db *Database, m ModelInterface, filter bson.M) (count int, err error) {
+func (db *MgoDatabase) ReadCollectionCount(m ModelInterface, filter bson.M) (count int, err error) {
 	defer func() {
 		if r := recover(); r != nil {
 			err = fmt.Errorf("%v", r)
@@ -255,7 +255,7 @@ func ReadCollectionCount(db *Database, m ModelInterface, filter bson.M) (count i
 }
 
 // UpdateDocument updates a document from specified model
-func UpdateDocument(db *Database, m ModelInterface, changes bson.M) error {
+func (db *MgoDatabase) UpdateDocument(m ModelInterface, changes bson.M) error {
 	m.PrepareUpdate()
 	changes["updateTime"] = time.Now()
 
@@ -266,7 +266,7 @@ func UpdateDocument(db *Database, m ModelInterface, changes bson.M) error {
 }
 
 // UpsertDocument updates a document from specified model or inserts it, of not found
-func UpsertDocument(db *Database, m ModelInterface, changes bson.M) error {
+func (db *MgoDatabase) UpsertDocument(m ModelInterface, changes bson.M) error {
 	m.PrepareUpdate()
 	changes["updateTime"] = time.Now()
 
@@ -277,7 +277,7 @@ func UpsertDocument(db *Database, m ModelInterface, changes bson.M) error {
 }
 
 // DeleteDocument deletes one document via its id
-func DeleteDocument(db *Database, m ModelInterface) error {
+func (db *MgoDatabase) DeleteDocument(m ModelInterface) error {
 	c := db.C(GetCollectionName(m))
 
 	err := c.RemoveId(m.GetID())
@@ -286,7 +286,7 @@ func DeleteDocument(db *Database, m ModelInterface) error {
 }
 
 // DeleteDocuments deletes documents found by filter
-func DeleteDocuments(db *Database, m ModelInterface, filter bson.M) (removed int, err error) {
+func (db *MgoDatabase) DeleteDocuments(m ModelInterface, filter bson.M) (removed int, err error) {
 	c := db.C(GetCollectionName(m))
 
 	info, err := c.RemoveAll(filter)

lookup.go

@@ -8,7 +8,7 @@ import (
 )
 
 // Lookup extends results with data for inline structs
-func Lookup(db *Database, structField string, results interface{}, selector bson.M) error {
+func (db *MgoDatabase) Lookup(structField string, results interface{}, selector bson.M) error {
 
 	t := reflect.TypeOf(results)
 	v := reflect.ValueOf(results)
@@ -122,7 +122,7 @@ func Lookup(db *Database, structField string, results interface{}, selector bson
 		return fmt.Errorf("ID type in objects struct %+v is not bson.ObjectId", fieldType)
 	}
 
-	err := ReadCollection(db, objectResults, sQuery, selector, 0, 0, nil, nil)
+	err := db.ReadCollection(objectResults, sQuery, selector, 0, 0, nil, nil)
 	if err != nil {
 		panic(err)
 	}

mgo.go

@@ -0,0 +1,233 @@
+package mgocrud
+
+import (
+	"errors"
+	"runtime"
+
+	mgo "gopkg.in/mgo.v2"
+)
+
+type MgoConnection struct {
+	connection *mgo.Session
+	closed     bool
+}
+
+func NewMgoConnection(dial string) (Connection, error) {
+	connection, err := mgo.Dial(dial)
+	if err != nil {
+		return nil, err
+	}
+	connection.SetMode(mgo.Monotonic, true)
+	c := &MgoConnection{connection: connection}
+	runtime.SetFinalizer(c, func(c *MgoConnection) {
+		if !c.closed {
+			c.Close()
+		}
+	})
+	return c, nil
+}
+
+func (c *MgoConnection) Close() {
+	if !c.closed {
+		c.connection.Close()
+		c.closed = true
+	}
+	runtime.SetFinalizer(c, nil)
+}
+
+type MgoSession struct {
+	connection *MgoConnection
+	session    *mgo.Session
+	closed     bool
+}
+
+func (s *MgoSession) Connection() Connection {
+	return s.connection
+}
+
+func (s *MgoSession) Close() {
+	if !s.closed {
+		s.session.Close()
+		s.closed = true
+	}
+	runtime.SetFinalizer(s, nil)
+}
+
+func (c *MgoConnection) NewSession() Session {
+	s := &MgoSession{
+		connection: c,
+		session:    c.connection.Copy(),
+	}
+	runtime.SetFinalizer(s, func(s *MgoSession) {
+		if !s.closed {
+			s.Close()
+		}
+	})
+	return s
+}
+
+type MgoDatabase struct {
+	database *mgo.Database
+	session  Session
+}
+
+func (s *MgoSession) DB(name string) Database {
+	return &MgoDatabase{database: s.session.DB(name), session: s}
+}
+
+type MgoCollection struct {
+	database   *MgoDatabase
+	collection *mgo.Collection
+}
+
+func (c *MgoCollection) DB() Database {
+	return c.database
+}
+
+func (db *MgoDatabase) Session() Session {
+	return db.session
+}
+
+func (db *MgoDatabase) C(name string) Collection {
+	return &MgoCollection{
+		database:   db,
+		collection: db.database.C(name),
+	}
+}
+
+func (db *MgoDatabase) Name() string {
+	return db.database.Name
+}
+
+func (c *MgoCollection) Insert(docs ...interface{}) error {
+	return c.collection.Insert(docs...)
+}
+
+func (c *MgoCollection) UpdateId(id interface{}, update interface{}) error {
+	return c.collection.UpdateId(id, update)
+}
+
+func (c *MgoCollection) RemoveId(id interface{}) error {
+	return c.collection.RemoveId(id)
+}
+
+type MgoChangeInfo struct {
+	changeInfo *mgo.ChangeInfo
+}
+
+func (ci *MgoChangeInfo) Matched() int {
+	return ci.changeInfo.Matched
+}
+
+func (ci *MgoChangeInfo) Removed() int {
+	return ci.changeInfo.Removed
+}
+
+func (ci *MgoChangeInfo) Updated() int {
+	return ci.changeInfo.Updated
+}
+
+func (c *MgoCollection) Upsert(selector interface{}, update interface{}) (ChangeInfo, error) {
+	ci, err := c.collection.Upsert(selector, update)
+	if err != nil {
+		return nil, err
+	}
+	return &MgoChangeInfo{changeInfo: ci}, nil
+}
+
+func (c *MgoCollection) RemoveAll(filter interface{}) (ChangeInfo, error) {
+	ci, err := c.collection.RemoveAll(filter)
+	if err != nil {
+		return nil, err
+	}
+	return &MgoChangeInfo{changeInfo: ci}, nil
+}
+
+type MgoQuery struct {
+	query *mgo.Query
+}
+
+func (c *MgoCollection) FindId(id interface{}) Query {
+	return &MgoQuery{query: c.collection.FindId(id)}
+}
+
+func (c *MgoCollection) Find(query interface{}) Query {
+	return &MgoQuery{query: c.collection.Find(query)}
+}
+
+func (q *MgoQuery) Select(selector interface{}) Query {
+	q.query = q.query.Select(selector)
+	return q
+}
+
+func (q *MgoQuery) One(result interface{}) error {
+	err := q.query.One(result)
+	if err == mgo.ErrNotFound {
+		err = ErrNotFound
+	}
+	return err
+}
+
+func (q *MgoQuery) Sort(fields ...string) Query {
+	q.query = q.query.Sort(fields...)
+	return q
+}
+
+func (q *MgoQuery) Skip(n int) Query {
+	q.query = q.query.Skip(n)
+	return q
+}
+
+func (q *MgoQuery) Limit(n int) Query {
+	q.query = q.query.Limit(n)
+	return q
+}
+
+func (q *MgoQuery) All(result interface{}) error {
+	err := q.query.All(result)
+	if err == mgo.ErrNotFound {
+		err = ErrNotFound
+	}
+	return err
+}
+
+func (q *MgoQuery) Count() (int, error) {
+	c, err := q.query.Count()
+	if err == mgo.ErrNotFound {
+		err = ErrNotFound
+	}
+	return c, err
+}
+
+type MgoIndex struct {
+	index *mgo.Index
+}
+
+func NewMgoIndex(index mgo.Index) Index {
+	return &MgoIndex{index: &index}
+}
+
+func (c *MgoCollection) EnsureIndex(index Index) error {
+	if i, ok := index.(*MgoIndex); ok {
+		if i != nil && i.index != nil {
+			return c.collection.EnsureIndex(*i.index)
+		}
+	}
+	return errors.New("index parameter not initialized with mgo.Index")
+}
+
+type MgoPipe struct {
+	pipe *mgo.Pipe
+}
+
+func (p *MgoPipe) All(result interface{}) error {
+	err := p.pipe.All(result)
+	if err == mgo.ErrNotFound {
+		err = ErrNotFound
+	}
+	return err
+}
+
+func (c *MgoCollection) Pipe(pipeline interface{}) Pipe {
+	return &MgoPipe{pipe: c.collection.Pipe(pipeline).AllowDiskUse()}
+}

session.go

@@ -1,190 +0,0 @@
-package mgocrud
-
-import (
-	"errors"
-
-	mgo "gopkg.in/mgo.v2"
-)
-
-type Session struct {
-	session *mgo.Session
-}
-
-func (s *Session) Close() {
-	s.session.Close()
-}
-
-func (s *Session) Copy() *Session {
-	return &Session{session: s.session.Copy()}
-}
-
-func NewSession(dial string) (*Session, error) {
-	session, err := mgo.Dial(dial)
-	if err != nil {
-		return nil, err
-	}
-	session.SetMode(mgo.Monotonic, true)
-	return &Session{session: session}, nil
-}
-
-type Database struct {
-	database *mgo.Database
-}
-
-func (s *Session) DB(name string) *Database {
-	return &Database{database: s.session.DB(name)}
-}
-
-type Collection struct {
-	collection *mgo.Collection
-}
-
-func (db *Database) C(name string) *Collection {
-	return &Collection{collection: db.database.C(name)}
-}
-
-func (db *Database) Name() string {
-	return db.database.Name
-}
-
-func (c *Collection) Insert(docs ...interface{}) error {
-	return c.collection.Insert(docs...)
-}
-
-func (c *Collection) UpdateId(id interface{}, update interface{}) error {
-	return c.collection.UpdateId(id, update)
-}
-
-func (c *Collection) RemoveId(id interface{}) error {
-	return c.collection.RemoveId(id)
-}
-
-type ChangeInfo struct {
-	changeInfo *mgo.ChangeInfo
-}
-
-func (ci *ChangeInfo) Matched() int {
-	return ci.changeInfo.Matched
-}
-
-func (ci *ChangeInfo) Removed() int {
-	return ci.changeInfo.Removed
-}
-
-func (ci *ChangeInfo) Updated() int {
-	return ci.changeInfo.Updated
-}
-
-func (c *Collection) Upsert(selector interface{}, update interface{}) (*ChangeInfo, error) {
-	ci, err := c.collection.Upsert(selector, update)
-	if err != nil {
-		return nil, err
-	}
-	return &ChangeInfo{changeInfo: ci}, nil
-}
-
-func (c *Collection) RemoveAll(filter interface{}) (*ChangeInfo, error) {
-	ci, err := c.collection.RemoveAll(filter)
-	if err != nil {
-		return nil, err
-	}
-	return &ChangeInfo{changeInfo: ci}, nil
-}
-
-type Query struct {
-	query *mgo.Query
-}
-
-func (c *Collection) FindId(id interface{}) *Query {
-	return &Query{query: c.collection.FindId(id)}
-}
-
-func (c *Collection) Find(query interface{}) *Query {
-	return &Query{query: c.collection.Find(query)}
-}
-
-func (q *Query) Select(selector interface{}) *Query {
-	q.query = q.query.Select(selector)
-	return q
-}
-
-func (q *Query) One(result interface{}) error {
-	err := q.query.One(result)
-	if err == mgo.ErrNotFound {
-		err = &ErrNotFound{msg: err.Error()}
-	}
-	return err
-}
-
-func (q *Query) Sort(fields ...string) *Query {
-	q.query = q.query.Sort(fields...)
-	return q
-}
-
-func (q *Query) Skip(n int) *Query {
-	q.query = q.query.Skip(n)
-	return q
-}
-
-func (q *Query) Limit(n int) *Query {
-	q.query = q.query.Limit(n)
-	return q
-}
-
-func (q *Query) All(result interface{}) error {
-	err := q.query.All(result)
-	if err == mgo.ErrNotFound {
-		err = &ErrNotFound{msg: err.Error()}
-	}
-	return err
-}
-
-func (q *Query) Count() (int, error) {
-	c, err := q.query.Count()
-	if err == mgo.ErrNotFound {
-		err = &ErrNotFound{msg: err.Error()}
-	}
-	return c, err
-}
-
-type Index struct {
-	index *mgo.Index
-}
-
-func NewMgoIndex(index mgo.Index) *Index {
-	return &Index{index: &index}
-}
-
-func (c *Collection) EnsureIndex(index *Index) error {
-	if index != nil && index.index != nil {
-		return c.collection.EnsureIndex(*index.index)
-	}
-	return errors.New("index parameter not initialized with mgo.Index")
-}
-
-type Pipe struct {
-	pipe *mgo.Pipe
-}
-
-func (p *Pipe) All(result interface{}) error {
-	err := p.pipe.All(result)
-	if err == mgo.ErrNotFound {
-		err = &ErrNotFound{msg: err.Error()}
-	}
-	return err
-}
-
-func (c *Collection) Pipe(pipeline interface{}) *Pipe {
-	return &Pipe{pipe: c.collection.Pipe(pipeline).AllowDiskUse()}
-}
-
-type ErrNotFound struct {
-	msg string
-}
-
-func (e *ErrNotFound) Error() string {
-	if e.msg == "" {
-		return "not found"
-	}
-	return e.msg
-}

setup.go

@@ -9,10 +9,22 @@ import (
 )
 
 // EnsureIndex ensured mongodb index reflecting model struct index tag
-func EnsureIndex(db *Database, m ModelInterface) error {
+func (db *MgoDatabase) EnsureIndex(m ModelInterface, index ...Index) error {
 	colName := GetCollectionName(m)
 	col := db.C(colName)
 
+	if len(index) > 0 {
+		// only ensure given index
+		for _, i := range index {
+			err := col.EnsureIndex(i)
+			if err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+
+	// ensure index by struct fields
 	mType := reflect.TypeOf(m)
 
 	textFields := []string{}

types.go

@@ -0,0 +1,72 @@
+package mgocrud
+
+import (
+	"errors"
+
+	"gopkg.in/mgo.v2/bson"
+)
+
+var (
+	ErrNotFound = errors.New("not found")
+)
+
+type Connection interface {
+	Close()
+	NewSession() Session
+}
+
+type Session interface {
+	Connection() Connection
+	Close()
+	DB(name string) Database
+}
+
+type Database interface {
+	Session() Session
+	// C(name string) Collection
+	Name() string
+	EnsureIndex(m ModelInterface, index ...Index) error
+	ReadDocument(m ModelInterface, selector bson.M) error
+	CreateDocument(m ModelInterface) error
+	ReadCollection(results interface{}, filter bson.M, selector bson.M, offset int, limit int, sort []string, pipelineModifier PipelineModifierFunction) error
+	ReadCollectionCount(m ModelInterface, filter bson.M) (count int, err error)
+	UpdateDocument(m ModelInterface, changes bson.M) error
+	UpsertDocument(m ModelInterface, changes bson.M) error
+	DeleteDocument(m ModelInterface) error
+	DeleteDocuments(m ModelInterface, filter bson.M) (removed int, err error)
+}
+
+type Collection interface {
+	DB() Database
+	Insert(docs ...interface{}) error
+	UpdateId(id interface{}, update interface{}) error
+	RemoveId(id interface{}) error
+	Upsert(selector interface{}, update interface{}) (ChangeInfo, error)
+	RemoveAll(filter interface{}) (ChangeInfo, error)
+	FindId(id interface{}) Query
+	Find(query interface{}) Query
+	EnsureIndex(index Index) error
+	Pipe(pipeline interface{}) Pipe
+}
+
+type ChangeInfo interface {
+	Matched() int
+	Removed() int
+	Updated() int
+}
+
+type Query interface {
+	Select(selector interface{}) Query
+	One(result interface{}) error
+	Sort(fields ...string) Query
+	Skip(n int) Query
+	Limit(n int) Query
+	All(result interface{}) error
+	Count() (int, error)
+}
+
+type Index interface{}
+
+type Pipe interface {
+	All(result interface{}) error
+}

validator.go

@@ -6,7 +6,7 @@ import (
 )
 
 // ValidateObject validates object via validator tag and custom method
-func ValidateObject(db *Database, m ModelInterface, changes bson.M) error {
+func ValidateObject(db Database, m ModelInterface, changes bson.M) error {
 	// first validate via struct tag
 	validator := validator.New(&validator.Config{
 		TagName: "validator",
@@ -18,7 +18,7 @@ func ValidateObject(db *Database, m ModelInterface, changes bson.M) error {
 
 	// next execute custom model validator if exists
 	if i, ok := m.(interface {
-		Validate(db *Database, changes bson.M) error
+		Validate(db Database, changes bson.M) error
 	}); ok {
 		return i.Validate(db, changes)
 	}