Merge pull request #3 from vgarvardt/patch/rename-packages

Renamed packages to avoid collision with drivers

Author: vgarvardt

README.md

@@ -12,10 +12,10 @@ $ go get -u -v github.com/vgarvardt/go-oauth2-pg
 
 The store accepts an adapter interface that interacts with the DB. The package is bundled with the following adapter implementations
 
-- `database/sql` (e.g. [`github.com/lib/pq`](https://github.com/lib/pq)) - `github.com/vgarvardt/go-oauth2-pg/adapter/sql.NewSQL()`
-- [`github.com/jmoiron/sqlx.DB`](https://github.com/jmoiron/sqlx) - `github.com/vgarvardt/go-oauth2-pg/adapter/sqlx.NewSQLx()`
-- [`github.com/jackc/pgx.Conn`](https://github.com/jackc/pgx) - `github.com/vgarvardt/go-oauth2-pg/adapter/pgx.NewConnAdapter()`
-- [`github.com/jackc/pgx.ConnPool`](https://github.com/jackc/pgx) - `github.com/vgarvardt/go-oauth2-pg/adapter/pgx.NewConnPoolAdapter()`
+- `database/sql` (e.g. [`github.com/lib/pq`](https://github.com/lib/pq)) - `github.com/vgarvardt/go-oauth2-pg/sql_adapter.New()`
+- [`github.com/jmoiron/sqlx.DB`](https://github.com/jmoiron/sqlx) - `github.com/vgarvardt/go-oauth2-pg/sql_adapter.NewX()`
+- [`github.com/jackc/pgx.Conn`](https://github.com/jackc/pgx) - `github.com/vgarvardt/go-oauth2-pg/pgx_adapter.NewConn()`
+- [`github.com/jackc/pgx.ConnPool`](https://github.com/jackc/pgx) - `github.com/vgarvardt/go-oauth2-pg/pgx_adapter.NewConnPool()`
 
 ## Usage example
 
@@ -28,7 +28,7 @@ import (
 
 	"github.com/jackc/pgx"
 	pg "github.com/vgarvardt/go-oauth2-pg"
-	pgxAdapter "github.com/vgarvardt/go-oauth2-pg/adapter/pgx"
+	pgxAdapter "github.com/vgarvardt/go-oauth2-pg/pgx_adapter"
 	"gopkg.in/oauth2.v3/manage"
 )
 
@@ -39,7 +39,7 @@ func main() {
 	manager := manage.NewDefaultManager()
 
 	// use PostgreSQL token store with pgx.Connection adapter
-	store, _ := pg.NewStore(pgxAdapter.NewConnAdapter(pgxConn), pg.WithGCInterval(time.Minute))
+	store, _ := pg.NewStore(pgxAdapter.NewConn(pgxConn), pg.WithGCInterval(time.Minute))
 	defer store.Close()
 
 	manager.MapTokenStorage(store)

adapter/pgx/adapter.go renamed to pgx_adapter/adapter.go

@@ -1,39 +1,39 @@
-package pgx
+package pgx_adapter
 
 import (
 	"github.com/jackc/pgx"
 	"github.com/vgarvardt/go-oauth2-pg"
 	pgxHelpers "github.com/vgarvardt/pgx-helpers"
 )
 
-// ConnPoolAdapter is the adapter type for PGx connection pool connection type
-type ConnPoolAdapter struct {
+// ConnPool is the adapter type for PGx connection pool connection type
+type ConnPool struct {
 	conn *pgx.ConnPool
 }
 
-// NewConnPoolAdapter instantiates PGx connection pool adapter
-func NewConnPoolAdapter(conn *pgx.ConnPool) *ConnPoolAdapter {
-	return &ConnPoolAdapter{conn}
+// NewConnPool instantiates PGx connection pool adapter
+func NewConnPool(conn *pgx.ConnPool) *ConnPool {
+	return &ConnPool{conn}
 }
 
-// ConnAdapter is the adapter type for PGx connection connection type
-type ConnAdapter struct {
+// Conn is the adapter type for PGx connection connection type
+type Conn struct {
 	conn *pgx.Conn
 }
 
-// NewConnAdapter instantiates PGx connection adapter
-func NewConnAdapter(conn *pgx.Conn) *ConnAdapter {
-	return &ConnAdapter{conn}
+// NewConn instantiates PGx connection adapter
+func NewConn(conn *pgx.Conn) *Conn {
+	return &Conn{conn}
 }
 
 // Exec runs a query and returns an error if any
-func (a *ConnPoolAdapter) Exec(query string, args ...interface{}) error {
+func (a *ConnPool) Exec(query string, args ...interface{}) error {
 	_, err := a.conn.Exec(query, args...)
 	return err
 }
 
 // SelectOne runs a select query and scans the object into a struct or returns an error
-func (a *ConnPoolAdapter) SelectOne(dst interface{}, query string, args ...interface{}) error {
+func (a *ConnPool) SelectOne(dst interface{}, query string, args ...interface{}) error {
 	row := a.conn.QueryRow(query, args...)
 	if err := pgxHelpers.ScanStruct(row, dst); err != nil {
 		if err == pgx.ErrNoRows {
@@ -46,13 +46,13 @@ func (a *ConnPoolAdapter) SelectOne(dst interface{}, query string, args ...inter
 }
 
 // Exec runs a query and returns an error if any
-func (a *ConnAdapter) Exec(query string, args ...interface{}) error {
+func (a *Conn) Exec(query string, args ...interface{}) error {
 	_, err := a.conn.Exec(query, args...)
 	return err
 }
 
 // SelectOne runs a select query and scans the object into a struct or returns an error
-func (a *ConnAdapter) SelectOne(dst interface{}, query string, args ...interface{}) error {
+func (a *Conn) SelectOne(dst interface{}, query string, args ...interface{}) error {
 	row := a.conn.QueryRow(query, args...)
 	if err := pgxHelpers.ScanStruct(row, dst); err != nil {
 		if err == pgx.ErrNoRows {

adapter/pgx/adapter_test.go renamed to pgx_adapter/adapter_test.go

@@ -1,4 +1,4 @@
-package pgx
+package pgx_adapter
 
 import (
 	"fmt"
@@ -53,7 +53,7 @@ func generateTableName() string {
 	return fmt.Sprintf("token_%d", time.Now().UnixNano())
 }
 
-func TestNewConnAdapter(t *testing.T) {
+func TestNewConn(t *testing.T) {
 	l := new(memoryLogger)
 
 	pgxConnConfig, err := pgx.ParseURI(uri)
@@ -68,7 +68,7 @@ func TestNewConnAdapter(t *testing.T) {
 		assert.NoError(t, pgxConn.Close())
 	}()
 
-	adapter := NewConnAdapter(pgxConn)
+	adapter := NewConn(pgxConn)
 	tableName := generateTableName()
 
 	store, err := pg.NewStore(adapter, pg.WithLogger(l), pg.WithTableName(tableName), pg.WithGCInterval(time.Second))
@@ -80,7 +80,7 @@ func TestNewConnAdapter(t *testing.T) {
 	runStoreTest(t, store, l)
 }
 
-func TestNewConnPoolAdapter(t *testing.T) {
+func TestNewConnPool(t *testing.T) {
 	l := new(memoryLogger)
 
 	pgxConnConfig, err := pgx.ParseURI(uri)
@@ -95,7 +95,7 @@ func TestNewConnPoolAdapter(t *testing.T) {
 
 	defer pgXConnPool.Close()
 
-	adapter := NewConnPoolAdapter(pgXConnPool)
+	adapter := NewConnPool(pgXConnPool)
 	tableName := generateTableName()
 
 	store, err := pg.NewStore(adapter, pg.WithLogger(l), pg.WithTableName(tableName), pg.WithGCInterval(time.Second))

adapter/sql/adapter.go renamed to sql_adapter/adapter.go

@@ -1,4 +1,4 @@
-package sql
+package sql_adapter
 
 import (
 	"database/sql"
@@ -11,14 +11,14 @@ type Adapter struct {
 	conn *sqlx.DB
 }
 
-// NewSQL instantiates sqlx.DB connection adapter from sql.DB connection
-func NewSQL(conn *sql.DB) *Adapter {
+// New instantiates sqlx.DB connection adapter from sql.DB connection
+func New(conn *sql.DB) *Adapter {
 	// The driverName of the original database is required for named query support - we do not use it here
 	return &Adapter{sqlx.NewDb(conn, "")}
 }
 
-// NewSQLx instantiates sqlx.DB connection adapter
-func NewSQLx(conn *sqlx.DB) *Adapter {
+// NewX instantiates sqlx.DB connection adapter
+func NewX(conn *sqlx.DB) *Adapter {
 	return &Adapter{conn}
 }
 

adapter/sql/adapter_test.go renamed to sql_adapter/adapter_test.go

@@ -1,4 +1,4 @@
-package sql
+package sql_adapter
 
 import (
 	"database/sql"
@@ -41,7 +41,7 @@ func generateTableName() string {
 	return fmt.Sprintf("token_%d", time.Now().UnixNano())
 }
 
-func TestNewSQL(t *testing.T) {
+func TestNew(t *testing.T) {
 	l := new(memoryLogger)
 
 	conn, err := sql.Open("pgx", uri)
@@ -51,7 +51,7 @@ func TestNewSQL(t *testing.T) {
 		assert.NoError(t, conn.Close())
 	}()
 
-	adapter := NewSQL(conn)
+	adapter := New(conn)
 	tableName := generateTableName()
 
 	store, err := pg.NewStore(adapter, pg.WithLogger(l), pg.WithTableName(tableName), pg.WithGCInterval(time.Second))
@@ -63,7 +63,7 @@ func TestNewSQL(t *testing.T) {
 	runStoreTest(t, store, l)
 }
 
-func TestNewSQLx(t *testing.T) {
+func TestNewX(t *testing.T) {
 	l := new(memoryLogger)
 
 	conn, err := sql.Open("pgx", uri)
@@ -73,7 +73,7 @@ func TestNewSQLx(t *testing.T) {
 		assert.NoError(t, conn.Close())
 	}()
 
-	adapter := NewSQLx(sqlx.NewDb(conn, ""))
+	adapter := NewX(sqlx.NewDb(conn, ""))
 	tableName := generateTableName()
 
 	store, err := pg.NewStore(adapter, pg.WithLogger(l), pg.WithTableName(tableName), pg.WithGCInterval(time.Second))