add doc blocks, split files

sqlmock.go

@@ -3,14 +3,15 @@ package sqlmock
 import (
 	"database/sql"
 	"database/sql/driver"
-	"errors"
 	"fmt"
 	"regexp"
-	"strings"
 )
 
 var mock *mockDriver
 
+// Mock interface defines a mock which is returned
+// by any expectation and can be detailed further
+// with the following methods
 type Mock interface {
 	WithArgs(...driver.Value) Mock
 	WillReturnError(error) Mock
@@ -22,6 +23,7 @@ type mockDriver struct {
 	conn *conn
 }
 
+// opens a mock driver database connection
 func (d *mockDriver) Open(dsn string) (driver.Conn, error) {
 	return mock.conn, nil
 }
@@ -31,30 +33,7 @@ func init() {
 	sql.Register("mock", mock)
 }
 
-type conn struct {
-	expectations []expectation
-	active       expectation
-}
-
-func stripQuery(q string) (s string) {
-	s = strings.Replace(q, "\n", " ", -1)
-	s = strings.Replace(s, "\r", "", -1)
-	s = strings.TrimSpace(s)
-	return
-}
-
-func (c *conn) Close() (err error) {
-	for _, e := range mock.conn.expectations {
-		if !e.fulfilled() {
-			err = errors.New(fmt.Sprintf("There is a remaining expectation %T which was not matched yet", e))
-			break
-		}
-	}
-	mock.conn.expectations = []expectation{}
-	mock.conn.active = nil
-	return err
-}
-
+// expect transaction to be started
 func ExpectBegin() Mock {
 	e := &expectedBegin{}
 	mock.conn.expectations = append(mock.conn.expectations, e)
@@ -62,6 +41,7 @@ func ExpectBegin() Mock {
 	return mock.conn
 }
 
+// expect transaction to be commited
 func ExpectCommit() Mock {
 	e := &expectedCommit{}
 	mock.conn.expectations = append(mock.conn.expectations, e)
@@ -69,6 +49,7 @@ func ExpectCommit() Mock {
 	return mock.conn
 }
 
+// expect transaction to be rolled back
 func ExpectRollback() Mock {
 	e := &expectedRollback{}
 	mock.conn.expectations = append(mock.conn.expectations, e)
@@ -81,62 +62,6 @@ func (c *conn) WillReturnError(err error) Mock {
 	return c
 }
 
-func (c *conn) Begin() (driver.Tx, error) {
-	e := c.next()
-	if e == nil {
-		return nil, errors.New("All expectations were already fulfilled, call to Begin transaction was not expected")
-	}
-
-	etb, ok := e.(*expectedBegin)
-	if !ok {
-		return nil, errors.New(fmt.Sprintf("Call to Begin transaction, was not expected, next expectation is %+v", e))
-	}
-	etb.triggered = true
-	return &transaction{c}, etb.err
-}
-
-// get next unfulfilled expectation
-func (c *conn) next() (e expectation) {
-	for _, e = range c.expectations {
-		if !e.fulfilled() {
-			return
-		}
-	}
-	return nil // all expectations were fulfilled
-}
-
-func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) {
-	e := c.next()
-	query = stripQuery(query)
-	if e == nil {
-		return nil, errors.New(fmt.Sprintf("All expectations were already fulfilled, call to Exec '%s' query with args %+v was not expected", query, args))
-	}
-
-	eq, ok := e.(*expectedExec)
-	if !ok {
-		return nil, errors.New(fmt.Sprintf("Call to Exec query '%s' with args %+v, was not expected, next expectation is %+v", query, args, e))
-	}
-
-	eq.triggered = true
-	if eq.err != nil {
-		return nil, eq.err // mocked to return error
-	}
-
-	if eq.result == nil {
-		return nil, errors.New(fmt.Sprintf("Exec query '%s' with args %+v, must return a database/sql/driver.Result, but it was not set for expectation %+v", query, args, eq))
-	}
-
-	if !eq.queryMatches(query) {
-		return nil, errors.New(fmt.Sprintf("Exec query '%s', does not match regex '%s'", query, eq.sqlRegex.String()))
-	}
-
-	if !eq.argsMatches(args) {
-		return nil, errors.New(fmt.Sprintf("Exec query '%s', args %+v does not match expected %+v", query, args, eq.args))
-	}
-
-	return eq.result, nil
-}
-
 func ExpectExec(sqlRegexStr string) Mock {
 	e := &expectedExec{}
 	e.sqlRegex = regexp.MustCompile(sqlRegexStr)
@@ -171,7 +96,7 @@ func (c *conn) WithArgs(args ...driver.Value) Mock {
 func (c *conn) WillReturnResult(result driver.Result) Mock {
 	eq, ok := c.active.(*expectedExec)
 	if !ok {
-		panic(fmt.Sprintf("driver.Result may be returned only by Exec expectations, current is %+v", c.active))
+		panic(fmt.Sprintf("driver.Result may be returned only by Exec expectations, current is %T", c.active))
 	}
 	eq.result = result
 	return c
@@ -180,44 +105,8 @@ func (c *conn) WillReturnResult(result driver.Result) Mock {
 func (c *conn) WillReturnRows(rows driver.Rows) Mock {
 	eq, ok := c.active.(*expectedQuery)
 	if !ok {
-		panic(fmt.Sprintf("driver.Rows may be returned only by Query expectations, current is %+v", c.active))
+		panic(fmt.Sprintf("driver.Rows may be returned only by Query expectations, current is %T", c.active))
 	}
 	eq.rows = rows
 	return c
 }
-
-func (c *conn) Prepare(query string) (driver.Stmt, error) {
-	return &statement{mock.conn, stripQuery(query)}, nil
-}
-
-func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) {
-	e := c.next()
-	query = stripQuery(query)
-	if e == nil {
-		return nil, errors.New(fmt.Sprintf("All expectations were already fulfilled, call to Query '%s' with args %+v was not expected", query, args))
-	}
-
-	eq, ok := e.(*expectedQuery)
-	if !ok {
-		return nil, errors.New(fmt.Sprintf("Call to Query '%s' with args %+v, was not expected, next expectation is %+v", query, args, e))
-	}
-
-	eq.triggered = true
-	if eq.err != nil {
-		return nil, eq.err // mocked to return error
-	}
-
-	if eq.rows == nil {
-		return nil, errors.New(fmt.Sprintf("Query '%s' with args %+v, must return a database/sql/driver.Rows, but it was not set for expectation %+v", query, args, eq))
-	}
-
-	if !eq.queryMatches(query) {
-		return nil, errors.New(fmt.Sprintf("Query '%s', does not match regex [%s]", query, eq.sqlRegex.String()))
-	}
-
-	if !eq.argsMatches(args) {
-		return nil, errors.New(fmt.Sprintf("Query '%s', args %+v does not match expected %+v", query, args, eq.args))
-	}
-
-	return eq.rows, nil
-}